esi::services::ServicePort Class Reference

Add a custom interface to a service client at a particular point in the design hierarchy. More...

#include <Services.h>

Inheritance diagram for esi::services::ServicePort:

Collaboration diagram for esi::services::ServicePort:

Public Member Functions
virtual	~ServicePort ()=default
virtual std::optional< std::string >	toString (bool oneLine=false) const
	BundlePort (AppID id, const BundleType *type, PortMap channels)
	Construct a port.
Public Member Functions inherited from esi::BundlePort
	BundlePort (AppID id, const BundleType *type, PortMap channels)
	Construct a port.
virtual	~BundlePort ()=default
AppID	getID () const
	Get the ID of the port.
WriteChannelPort &	getRawWrite (const std::string &name) const
	Get access to the raw byte streams of a channel.
ReadChannelPort &	getRawRead (const std::string &name) const
const PortMap &	getChannels () const
template<typename T>
T *	getAs () const
	Cast this Bundle port to a subclass which is actually useful.
bool	poll ()
	Calls poll on all channels in the bundle and returns true if any of them returned true.

Additional Inherited Members
Static Public Member Functions inherited from esi::BundlePort
static bool	isWrite (BundleType::Direction bundleDir)
	Compute the direction of a channel given the bundle direction and the bundle port's direction.
Protected Attributes inherited from esi::BundlePort
AppID	id
const BundleType *	type
PortMap	channels

Detailed Description

Add a custom interface to a service client at a particular point in the design hierarchy.

Definition at line 47 of file Services.h.

Constructor & Destructor Documentation

~ServicePort()

virtual esi::services::ServicePort::~ServicePort ( )

virtualdefault

Member Function Documentation

BundlePort()

BundlePort::BundlePort	(	AppID	id,
		const BundleType *	type,
		PortMap	channels )

Construct a port.

Definition at line 646 of file Ports.cpp.

toString()

virtual std::optional< std::string > esi::services::ServicePort::toString ( bool oneLine = false ) const

inlinevirtual

Reimplemented in esi::services::CallService::Callback, esi::services::ChannelService::FromHost, esi::services::ChannelService::ToHost, esi::services::FuncService::Function, esi::services::MMIO::MMIORegion, and esi::services::TelemetryService::Metric.

Definition at line 52 of file Services.h.

---

The documentation for this class was generated from the following file:

• /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Services.h