CIRCT 20.0.0git
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for esi::services::ServicePort:
Collaboration graph
[legend]

Public Member Functions

virtual ~ServicePort ()=default
 
virtual std::optional< std::string > toString () const
 
 BundlePort (AppID id, std::map< std::string, ChannelPort & > channels)
 Construct a port.
 
- Public Member Functions inherited from esi::BundlePort
 BundlePort (AppID id, std::map< std::string, ChannelPort & > channels)
 Construct a port.
 
virtual ~BundlePort ()=default
 
AppID getID () const
 Get the ID of the port.
 
WriteChannelPortgetRawWrite (const std::string &name) const
 Get access to the raw byte streams of a channel.
 
ReadChannelPortgetRawRead (const std::string &name) const
 
const std::map< std::string, ChannelPort & > & 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.
 

Detailed Description

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

Definition at line 35 of file Services.h.

Constructor & Destructor Documentation

◆ ~ServicePort()

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

Member Function Documentation

◆ BundlePort()

BundlePort::BundlePort ( AppID  id,
std::map< std::string, ChannelPort & >  channels 
)

Construct a port.

Definition at line 193 of file Ports.cpp.

◆ toString()

virtual std::optional< std::string > esi::services::ServicePort::toString ( ) const
inlinevirtual

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