esi::TypedWritePort< T, SkipTypeCheck > Class Template Reference

#include <TypedPorts.h>

Inheritance diagram for esi::TypedWritePort< T, SkipTypeCheck >:

Collaboration diagram for esi::TypedWritePort< T, SkipTypeCheck >:

Public Member Functions
	TypedWritePort (WriteChannelPort &port)
	TypedWritePort (WriteChannelPort *port)
void	connect (const ChannelPort::ConnectOptions &opts={std::nullopt, false})
void	write (const T &data)
void	write (std::unique_ptr< T > &data)
	Write by taking ownership.
bool	tryWrite (const T &data)
bool	tryWrite (std::unique_ptr< T > &data)
	Non-blocking write by taking ownership.
bool	flush ()
void	disconnect ()
bool	isConnected () const
WriteChannelPort &	raw ()
const WriteChannelPort &	raw () const

Private Attributes
WriteChannelPort *	inner
WireInfo	wireInfo_

Detailed Description

template<typename T, bool SkipTypeCheck = false>
class esi::TypedWritePort< T, SkipTypeCheck >

Definition at line 613 of file TypedPorts.h.

Constructor & Destructor Documentation

TypedWritePort() [1/2]

template<typename T, bool SkipTypeCheck = false>

esi::TypedWritePort< T, SkipTypeCheck >::TypedWritePort ( WriteChannelPort & port )

inlineexplicit

Definition at line 615 of file TypedPorts.h.

References inner.

TypedWritePort() [2/2]

template<typename T, bool SkipTypeCheck = false>

esi::TypedWritePort< T, SkipTypeCheck >::TypedWritePort ( WriteChannelPort * port )

inline

Definition at line 617 of file TypedPorts.h.

References inner.

Member Function Documentation

connect()

template<typename T, bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::connect ( const ChannelPort::ConnectOptions & opts = {std::nullopt, false} )

inline

Definition at line 619 of file TypedPorts.h.

Referenced by autoSerialCoordTranslateTest(), runCustomServiceDeclChannel(), runLoopbackI8(), serialCoordTranslate(), and serialCoordTranslateTest().

disconnect()

template<typename T, bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::disconnect ( )

inline

Definition at line 671 of file TypedPorts.h.

References inner.

Referenced by autoSerialCoordTranslateTest(), and serialCoordTranslateTest().

flush()

template<typename T, bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::flush ( )

inline

Definition at line 670 of file TypedPorts.h.

References inner.

isConnected()

template<typename T, bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::isConnected ( ) const

inline

Definition at line 672 of file TypedPorts.h.

References inner.

raw() [1/2]

template<typename T, bool SkipTypeCheck = false>

WriteChannelPort & esi::TypedWritePort< T, SkipTypeCheck >::raw ( )

inline

Definition at line 674 of file TypedPorts.h.

References inner.

raw() [2/2]

template<typename T, bool SkipTypeCheck = false>

const WriteChannelPort & esi::TypedWritePort< T, SkipTypeCheck >::raw ( ) const

inline

Definition at line 675 of file TypedPorts.h.

References inner.

tryWrite() [1/2]

template<typename T, bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::tryWrite ( const T & data )

inline

Definition at line 644 of file TypedPorts.h.

References inner, esi::toMessageData(), and wireInfo_.

Referenced by tryWrite().

tryWrite() [2/2]

template<typename T, bool SkipTypeCheck = false>

bool esi::TypedWritePort< T, SkipTypeCheck >::tryWrite ( std::unique_ptr< T > & data )

inline

Non-blocking write by taking ownership.

On success, data is consumed (left null) and true is returned. On failure, data is left untouched so the caller can retry. If T is a SegmentedMessageData, this hands the message directly to the port's segmented tryWrite path.

Definition at line 652 of file TypedPorts.h.

References inner, and tryWrite().

write() [1/2]

template<typename T, bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::write ( const T & data )

inline

Definition at line 629 of file TypedPorts.h.

References inner, esi::toMessageData(), and wireInfo_.

Referenced by autoSerialCoordTranslateTest(), runCustomServiceDeclChannel(), runLoopbackI8(), serialCoordTranslate(), serialCoordTranslateTest(), and write().

write() [2/2]

template<typename T, bool SkipTypeCheck = false>

void esi::TypedWritePort< T, SkipTypeCheck >::write ( std::unique_ptr< T > & data )

inline

Write by taking ownership.

If T is a SegmentedMessageData, this hands the message directly to the port's segmented write path.

Definition at line 633 of file TypedPorts.h.

References inner, and write().

Member Data Documentation

inner

template<typename T, bool SkipTypeCheck = false>

WriteChannelPort* esi::TypedWritePort< T, SkipTypeCheck >::inner

private

Definition at line 678 of file TypedPorts.h.

Referenced by disconnect(), flush(), isConnected(), raw(), raw(), tryWrite(), tryWrite(), TypedWritePort(), TypedWritePort(), write(), and write().

wireInfo_

template<typename T, bool SkipTypeCheck = false>

WireInfo esi::TypedWritePort< T, SkipTypeCheck >::wireInfo_

private

Definition at line 679 of file TypedPorts.h.

Referenced by tryWrite(), and write().

---

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