CIRCT  20.0.0git
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
esi::services::FuncService::Function Class Reference

A function call which gets attached to a service port. More...

#include <Services.h>

Inheritance diagram for esi::services::FuncService::Function:
Inheritance graph
[legend]
Collaboration diagram for esi::services::FuncService::Function:
Collaboration graph
[legend]

Public Member Functions

void connect ()
 
std::future< MessageDatacall (const MessageData &arg)
 
virtual std::optional< std::string > toString () const override
 
- Public Member Functions inherited from esi::services::ServicePort
virtual ~ServicePort ()=default
 
 BundlePort (AppID id, std::map< std::string, ChannelPort & > channels)
 Construct a port. More...
 
- Public Member Functions inherited from esi::BundlePort
 BundlePort (AppID id, std::map< std::string, ChannelPort & > channels)
 Construct a port. More...
 
virtual ~BundlePort ()=default
 
AppID getID () const
 Get the ID of the port. More...
 
WriteChannelPortgetRawWrite (const std::string &name) const
 Get access to the raw byte streams of a channel. More...
 
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. More...
 
bool poll ()
 Calls poll on all channels in the bundle and returns true if any of them returned true. More...
 

Static Public Member Functions

static Functionget (AppID id, WriteChannelPort &arg, ReadChannelPort &result)
 
- 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. More...
 

Private Member Functions

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

Private Attributes

std::mutex callMutex
 
WriteChannelPortarg
 
ReadChannelPortresult
 

Friends

class FuncService
 

Detailed Description

A function call which gets attached to a service port.

Definition at line 247 of file Services.h.

Constructor & Destructor Documentation

◆ Function()

FuncService::Function::Function ( AppID  id,
const std::map< std::string, ChannelPort & > &  channels 
)
private

Definition at line 196 of file Services.cpp.

References assert(), and esi::BundlePort::channels.

Member Function Documentation

◆ call()

std::future< MessageData > FuncService::Function::call ( const MessageData arg)

Definition at line 216 of file Services.cpp.

Referenced by esiaccel.types.FunctionPort::__call__().

◆ connect()

void FuncService::Function::connect ( )

Definition at line 210 of file Services.cpp.

Referenced by PYBIND11_MODULE().

◆ get()

FuncService::Function * FuncService::Function::get ( AppID  id,
WriteChannelPort arg,
ReadChannelPort result 
)
static

Definition at line 204 of file Services.cpp.

◆ toString()

virtual std::optional<std::string> esi::services::FuncService::Function::toString ( ) const
inlineoverridevirtual

Reimplemented from esi::services::ServicePort.

Definition at line 258 of file Services.h.

References arg, esi::Type::getID(), esi::ChannelPort::getType(), and result.

Friends And Related Function Documentation

◆ FuncService

friend class FuncService
friend

Definition at line 248 of file Services.h.

Member Data Documentation

◆ arg

WriteChannelPort& esi::services::FuncService::Function::arg
private

Definition at line 268 of file Services.h.

Referenced by toString().

◆ callMutex

std::mutex esi::services::FuncService::Function::callMutex
private

Definition at line 267 of file Services.h.

◆ result

ReadChannelPort& esi::services::FuncService::Function::result
private

Definition at line 269 of file Services.h.

Referenced by toString().


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