esi::TypedFunction< void, ResultT, SkipTypeCheck > Class Template Reference

Partial specialization: void argument, typed result. More...

#include <TypedPorts.h>

Collaboration diagram for esi::TypedFunction< void, ResultT, SkipTypeCheck >:

Public Member Functions
	TypedFunction (services::FuncService::Function *func)
	TypedFunction (const TypedFunction &)=delete
TypedFunction &	operator= (const TypedFunction &)=delete
void	connect ()
std::future< ResultT >	call ()
std::future< ResultT >	operator() ()
	Function-call operator overload: forwards to call().
services::FuncService::Function &	raw ()
const services::FuncService::Function &	raw () const

Private Attributes
services::FuncService::Function *	inner
std::optional< TypedWritePort< void > >	argPort
std::optional< TypedReadPort< ResultT, SkipTypeCheck > >	resultPort
std::mutex	callMutex

Detailed Description

template<typename ResultT, bool SkipTypeCheck>
class esi::TypedFunction< void, ResultT, SkipTypeCheck >

Partial specialization: void argument, typed result.

Definition at line 1080 of file TypedPorts.h.

Constructor & Destructor Documentation

TypedFunction() [1/2]

template<typename ResultT , bool SkipTypeCheck>

esi::TypedFunction< void, ResultT, SkipTypeCheck >::TypedFunction ( services::FuncService::Function *  func )

inline

Definition at line 1083 of file TypedPorts.h.

TypedFunction() [2/2]

template<typename ResultT , bool SkipTypeCheck>

esi::TypedFunction< void, ResultT, SkipTypeCheck >::TypedFunction ( const TypedFunction< void, ResultT, SkipTypeCheck > &  )

delete

Member Function Documentation

call()

template<typename ResultT , bool SkipTypeCheck>

std::future< ResultT > esi::TypedFunction< void, ResultT, SkipTypeCheck >::call ( )

inline

Definition at line 1099 of file TypedPorts.h.

References esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::argPort, esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::callMutex, esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::resultPort, and esi::detail::throwNotConnected().

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

connect()

template<typename ResultT , bool SkipTypeCheck>

void esi::TypedFunction< void, ResultT, SkipTypeCheck >::connect ( )

inline

Definition at line 1087 of file TypedPorts.h.

References esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::argPort, esi::BundlePort::getRawRead(), esi::BundlePort::getRawWrite(), esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::inner, esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::resultPort, esi::detail::throwAlreadyConnected(), esi::detail::throwNullFunction(), and esi::detail::typedFunctionConnectOptions().

operator()()

template<typename ResultT , bool SkipTypeCheck>

std::future< ResultT > esi::TypedFunction< void, ResultT, SkipTypeCheck >::operator() ( )

inline

Function-call operator overload: forwards to call().

Definition at line 1108 of file TypedPorts.h.

References esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::call().

operator=()

template<typename ResultT , bool SkipTypeCheck>

TypedFunction & esi::TypedFunction< void, ResultT, SkipTypeCheck >::operator= ( const TypedFunction< void, ResultT, SkipTypeCheck > &  )

delete

raw() [1/2]

template<typename ResultT , bool SkipTypeCheck>

services::FuncService::Function & esi::TypedFunction< void, ResultT, SkipTypeCheck >::raw ( )

inline

Definition at line 1110 of file TypedPorts.h.

References esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::inner.

raw() [2/2]

template<typename ResultT , bool SkipTypeCheck>

const services::FuncService::Function & esi::TypedFunction< void, ResultT, SkipTypeCheck >::raw ( ) const

inline

Definition at line 1111 of file TypedPorts.h.

References esi::TypedFunction< ArgT, ResultT, SkipTypeCheck >::inner.

Member Data Documentation

argPort

template<typename ResultT , bool SkipTypeCheck>

std::optional<TypedWritePort<void> > esi::TypedFunction< void, ResultT, SkipTypeCheck >::argPort

private

Definition at line 1115 of file TypedPorts.h.

callMutex

template<typename ResultT , bool SkipTypeCheck>

std::mutex esi::TypedFunction< void, ResultT, SkipTypeCheck >::callMutex

private

Definition at line 1117 of file TypedPorts.h.

inner

template<typename ResultT , bool SkipTypeCheck>

services::FuncService::Function* esi::TypedFunction< void, ResultT, SkipTypeCheck >::inner

private

Definition at line 1114 of file TypedPorts.h.

resultPort

template<typename ResultT , bool SkipTypeCheck>

std::optional<TypedReadPort<ResultT, SkipTypeCheck> > esi::TypedFunction< void, ResultT, SkipTypeCheck >::resultPort

private

Definition at line 1116 of file TypedPorts.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/TypedPorts.h