esi::services::CallService::Callback Class Reference

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

#include <Services.h>

Inheritance diagram for esi::services::CallService::Callback:

Collaboration diagram for esi::services::CallService::Callback:

Public Member Functions
void	connect (std::function< MessageData(const MessageData &)> callback, bool quick=false)
	Connect a callback to code which will be executed when the accelerator invokes the callback.
const esi::Type *	getArgType () const
const esi::Type *	getResultType () const
virtual std::optional< std::string >	toString (bool oneLine=false) const override
Public Member Functions inherited from esi::services::ServicePort
virtual	~ServicePort ()=default
	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.

Static Public Member Functions
static Callback *	get (AcceleratorConnection &acc, AppID id, const BundleType *type, WriteChannelPort &result, ReadChannelPort &arg)
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.

Private Member Functions
	Callback (AcceleratorConnection &acc, AppID id, const BundleType *, PortMap channels)

Private Attributes
ReadChannelPort *	arg
WriteChannelPort *	result
AcceleratorConnection &	acc

Friends
class	CallService

Additional Inherited Members
Protected Attributes inherited from esi::BundlePort
AppID	id
const BundleType *	type
PortMap	channels

Detailed Description

A function call which gets attached to a service port.

Definition at line 405 of file Services.h.

Constructor & Destructor Documentation

Callback()

CallService::Callback::Callback ( AcceleratorConnection &  acc, AppID  id, const BundleType *  type, PortMap  channels  )

private

Definition at line 330 of file Services.cpp.

Member Function Documentation

connect()

void CallService::Callback::connect	(	std::function< MessageData(const MessageData &)>	callback,
		bool	quick = false
	)

Connect a callback to code which will be executed when the accelerator invokes the callback.

The 'quick' flag indicates that the callback is sufficiently fast that it could be called in the same thread as the port callback.

Definition at line 342 of file Services.cpp.

Referenced by esi::TypedCallback< void, ResultT >::connect(), esi::TypedCallback< ArgT, ResultT >::connect(), esi::TypedCallback< void, void >::connect(), and esi::TypedCallback< ArgT, void >::connect().

get()

CallService::Callback * CallService::Callback::get ( AcceleratorConnection &  acc, AppID  id, const BundleType *  type, WriteChannelPort &  result, ReadChannelPort &  arg  )

static

Definition at line 334 of file Services.cpp.

getArgType()

const esi::Type * esi::services::CallService::Callback::getArgType ( ) const

inline

Definition at line 422 of file Services.h.

References esi::BundleType::findChannel(), and esi::BundlePort::type.

Referenced by esi::TypedCallback< void, ResultT >::connect(), esi::TypedCallback< ArgT, ResultT >::connect(), esi::TypedCallback< void, void >::connect(), esi::TypedCallback< ArgT, void >::connect(), and toString().

getResultType()

const esi::Type * esi::services::CallService::Callback::getResultType ( ) const

inline

Definition at line 427 of file Services.h.

References esi::BundleType::findChannel(), and esi::BundlePort::type.

Referenced by esi::TypedCallback< void, ResultT >::connect(), esi::TypedCallback< ArgT, ResultT >::connect(), esi::TypedCallback< void, void >::connect(), esi::TypedCallback< ArgT, void >::connect(), and toString().

toString()

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

inlineoverridevirtual

Reimplemented from esi::services::ServicePort.

Definition at line 434 of file Services.h.

References getArgType(), getResultType(), and esi::Type::toString().

Friends And Related Symbol Documentation

CallService

friend class CallService

friend

Definition at line 406 of file Services.h.

Member Data Documentation

acc

AcceleratorConnection& esi::services::CallService::Callback::acc

private

Definition at line 444 of file Services.h.

arg

ReadChannelPort* esi::services::CallService::Callback::arg

private

Definition at line 442 of file Services.h.

result

WriteChannelPort* esi::services::CallService::Callback::result

private

Definition at line 443 of file Services.h.

---

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

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