esi::TypedReadPort< T > Class Template Reference

#include <TypedPorts.h>

Collaboration diagram for esi::TypedReadPort< T >:

Public Member Functions
	TypedReadPort (ReadChannelPort &port)
	TypedReadPort (ReadChannelPort *port)
void	connect (const ChannelPort::ConnectOptions &opts={})
void	connect (std::function< bool(const T &)> callback, const ChannelPort::ConnectOptions &opts={})
T	read ()
std::future< T >	readAsync ()
void	disconnect ()
bool	isConnected () const
ReadChannelPort &	raw ()
const ReadChannelPort &	raw () const

Private Attributes
ReadChannelPort *	inner
WireInfo	wireInfo_

Detailed Description

template<typename T>
class esi::TypedReadPort< T >

Definition at line 329 of file TypedPorts.h.

Constructor & Destructor Documentation

TypedReadPort() [1/2]

template<typename T >

esi::TypedReadPort< T >::TypedReadPort ( ReadChannelPort &  port )

inlineexplicit

Definition at line 331 of file TypedPorts.h.

TypedReadPort() [2/2]

template<typename T >

esi::TypedReadPort< T >::TypedReadPort ( ReadChannelPort *  port )

inline

Definition at line 333 of file TypedPorts.h.

Member Function Documentation

connect() [1/2]

template<typename T >

void esi::TypedReadPort< T >::connect ( const ChannelPort::ConnectOptions &  opts = {} )

inline

Definition at line 335 of file TypedPorts.h.

Referenced by runLoopbackI8().

connect() [2/2]

template<typename T >

void esi::TypedReadPort< T >::connect ( std::function< bool(const T &)>  callback, const ChannelPort::ConnectOptions &  opts = {}  )

inline

Definition at line 343 of file TypedPorts.h.

disconnect()

template<typename T >

void esi::TypedReadPort< T >::disconnect ( )

inline

Definition at line 373 of file TypedPorts.h.

References esi::ReadChannelPort::disconnect(), and esi::TypedReadPort< T >::inner.

isConnected()

template<typename T >

bool esi::TypedReadPort< T >::isConnected ( ) const

inline

Definition at line 374 of file TypedPorts.h.

References esi::TypedReadPort< T >::inner, and esi::ReadChannelPort::isConnected().

raw() [1/2]

template<typename T >

ReadChannelPort & esi::TypedReadPort< T >::raw ( )

inline

Definition at line 376 of file TypedPorts.h.

References esi::TypedReadPort< T >::inner.

raw() [2/2]

template<typename T >

const ReadChannelPort & esi::TypedReadPort< T >::raw ( ) const

inline

Definition at line 377 of file TypedPorts.h.

References esi::TypedReadPort< T >::inner.

read()

template<typename T >

T esi::TypedReadPort< T >::read ( )

inline

Definition at line 357 of file TypedPorts.h.

References esi::TypedReadPort< T >::inner, esi::ReadChannelPort::read(), and esi::TypedReadPort< T >::wireInfo_.

Referenced by runLoopbackI8().

readAsync()

template<typename T >

std::future< T > esi::TypedReadPort< T >::readAsync ( )

inline

Definition at line 363 of file TypedPorts.h.

References esi::TypedReadPort< T >::inner, esi::ReadChannelPort::readAsync(), and esi::TypedReadPort< T >::wireInfo_.

Member Data Documentation

inner

template<typename T >

ReadChannelPort* esi::TypedReadPort< T >::inner

private

Definition at line 380 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T >::disconnect(), esi::TypedReadPort< void >::disconnect(), esi::TypedReadPort< T >::isConnected(), esi::TypedReadPort< void >::isConnected(), esi::TypedReadPort< T >::raw(), esi::TypedReadPort< void >::raw(), esi::TypedReadPort< T >::raw(), esi::TypedReadPort< void >::raw(), esi::TypedReadPort< T >::read(), esi::TypedReadPort< void >::read(), esi::TypedReadPort< T >::readAsync(), and esi::TypedReadPort< void >::readAsync().

wireInfo_

template<typename T >

WireInfo esi::TypedReadPort< T >::wireInfo_

private

Definition at line 381 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T >::read(), and esi::TypedReadPort< T >::readAsync().

---

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