Strongly typed wrapper around a raw read channel. More...

#include <TypedPorts.h>

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

[legend]

Public Member Functions
	TypedReadPort (ReadChannelPort &port)

	TypedReadPort (ReadChannelPort *port)

	TypedReadPort (const TypedReadPort &)=delete

TypedReadPort &	operator= (const TypedReadPort &)=delete

	TypedReadPort (TypedReadPort &&)=delete

TypedReadPort &	operator= (TypedReadPort &&)=delete

	~TypedReadPort ()

void	connect (const ChannelPort::ConnectOptions &opts={std::nullopt, false})
	Connect in polling mode.

void	connect (std::function< bool(const T &)> callback, const ChannelPort::ConnectOptions &opts={std::nullopt, false})
	Connect a non-owning typed callback.

void	connect (detail::TypedReadOwnedCallback< T > callback, const ChannelPort::ConnectOptions &opts={std::nullopt, false})
	Connect an owning typed callback.

std::unique_ptr< T >	read ()
	Blocking typed read in polling mode.

std::future< std::unique_ptr< T > >	readAsync ()
	Asynchronous typed read in polling mode.

void	setMaxDataQueueMsgs (uint64_t maxMsgs)
	Set the maximum number of decoded typed values buffered in polling mode.

void	disconnect ()
	Disconnect the typed port and abandon any pending polling reads.

bool	isConnected () const

ReadChannelPort &	raw ()

const ReadChannelPort &	raw () const

Private Types
enum	Mode { Disconnected , Callback , Polling }

using	Deserializer = detail::DeserializerFor< T >

using	PollingState = detail::PollingBuffer< std::unique_ptr< T > >

Private Member Functions
void	resetConnectState ()

void	emplaceDeserializer (detail::DeserializerOutputCallback< T > callback)

void	prepareConnect ()

Private Attributes
ReadChannelPort *	inner

WireInfo	wireInfo_

Mode	mode = Mode::Disconnected

uint64_t	maxDataQueueMsgs = ReadChannelPort::DefaultMaxDataQueueMsgs

std::optional< Deserializer >	deserializer

std::optional< PollingState >	pollingState

Detailed Description

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

Strongly typed wrapper around a raw read channel.

For scalar/POD-like T, this performs a 1:1 conversion from raw messages. If T defines a nested TypeDeserializer, one instance is created per connection and drives both callback and polling reads through that deserializer.

Polling reads return std::unique_ptr<T> so complex decoded values can be delivered without an extra copy.

Definition at line 718 of file TypedPorts.h.

Member Typedef Documentation

◆ Deserializer

template<typename T , bool SkipTypeCheck = false>

using esi::TypedReadPort< T, SkipTypeCheck >::Deserializer = detail::DeserializerFor<T>

private

Definition at line 850 of file TypedPorts.h.

◆ PollingState

template<typename T , bool SkipTypeCheck = false>

using esi::TypedReadPort< T, SkipTypeCheck >::PollingState = detail::PollingBuffer<std::unique_ptr<T> >

private

Definition at line 852 of file TypedPorts.h.

Member Enumeration Documentation

◆ Mode

template<typename T , bool SkipTypeCheck = false>

enum esi::TypedReadPort::Mode

private

Enumerator
Disconnected
Callback
Polling

Definition at line 851 of file TypedPorts.h.

Constructor & Destructor Documentation

◆ TypedReadPort() [1/4]

template<typename T , bool SkipTypeCheck = false>

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

inlineexplicit

Definition at line 720 of file TypedPorts.h.

◆ TypedReadPort() [2/4]

template<typename T , bool SkipTypeCheck = false>

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

inline

Definition at line 722 of file TypedPorts.h.

◆ TypedReadPort() [3/4]

template<typename T , bool SkipTypeCheck = false>

esi::TypedReadPort< T, SkipTypeCheck >::TypedReadPort ( const TypedReadPort< T, SkipTypeCheck > & )

delete

◆ TypedReadPort() [4/4]

template<typename T , bool SkipTypeCheck = false>

esi::TypedReadPort< T, SkipTypeCheck >::TypedReadPort ( TypedReadPort< T, SkipTypeCheck > && )

delete

◆ ~TypedReadPort()

template<typename T , bool SkipTypeCheck = false>

esi::TypedReadPort< T, SkipTypeCheck >::~TypedReadPort ( )

inline

Definition at line 728 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::disconnect(), esi::TypedReadPort< T, SkipTypeCheck >::Disconnected, esi::TypedReadPort< T, SkipTypeCheck >::inner, and esi::TypedReadPort< T, SkipTypeCheck >::mode.

Member Function Documentation

◆ connect() [1/3]

template<typename T , bool SkipTypeCheck = false>

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

inline

Connect in polling mode.

The port installs an internal typed output queue. read() and readAsync() consume from that queue.

Definition at line 737 of file TypedPorts.h.

Referenced by runCustomServiceDeclChannel(), and runLoopbackI8().

◆ connect() [2/3]

template<typename T , bool SkipTypeCheck = false>

void esi::TypedReadPort< T, SkipTypeCheck >::connect	(	detail::TypedReadOwnedCallback< T >	callback,
		const ChannelPort::ConnectOptions &	opts = `{std::nullopt, false}`
	)

inline

Connect an owning typed callback.

This is the typed analogue of ReadChannelPort::ReadCallback: the callback may take ownership of the decoded value or return false to retry delivery later with the same object.

Definition at line 777 of file TypedPorts.h.

◆ connect() [3/3]

template<typename T , bool SkipTypeCheck = false>

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

inline

Connect a non-owning typed callback.

The callback sees the decoded value by reference. Returning false requests that the same decoded value be retried later.

Definition at line 764 of file TypedPorts.h.

◆ disconnect()

template<typename T , bool SkipTypeCheck = false>

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

inline

Disconnect the typed port and abandon any pending polling reads.

Definition at line 839 of file TypedPorts.h.

References esi::ReadChannelPort::disconnect(), esi::TypedReadPort< T, SkipTypeCheck >::Disconnected, esi::TypedReadPort< T, SkipTypeCheck >::inner, esi::TypedReadPort< T, SkipTypeCheck >::mode, and esi::TypedReadPort< T, SkipTypeCheck >::resetConnectState().

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::~TypedReadPort(), and esi::TypedReadPort< void >::~TypedReadPort().

◆ emplaceDeserializer()

template<typename T , bool SkipTypeCheck = false>

void esi::TypedReadPort< T, SkipTypeCheck >::emplaceDeserializer ( detail::DeserializerOutputCallback< T > callback )

inlineprivate

Definition at line 859 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::deserializer, and esi::TypedReadPort< T, SkipTypeCheck >::wireInfo_.

◆ isConnected()

template<typename T , bool SkipTypeCheck = false>

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

inline

Definition at line 844 of file TypedPorts.h.

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

◆ operator=() [1/2]

template<typename T , bool SkipTypeCheck = false>

TypedReadPort & esi::TypedReadPort< T, SkipTypeCheck >::operator= ( const TypedReadPort< T, SkipTypeCheck > & )

delete

◆ operator=() [2/2]

template<typename T , bool SkipTypeCheck = false>

TypedReadPort & esi::TypedReadPort< T, SkipTypeCheck >::operator= ( TypedReadPort< T, SkipTypeCheck > && )

delete

◆ prepareConnect()

template<typename T , bool SkipTypeCheck = false>

void esi::TypedReadPort< T, SkipTypeCheck >::prepareConnect ( )

inlineprivate

Definition at line 867 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::Disconnected, esi::ChannelPort::getType(), esi::getWireInfo(), esi::TypedReadPort< T, SkipTypeCheck >::inner, esi::TypedReadPort< T, SkipTypeCheck >::mode, and esi::TypedReadPort< T, SkipTypeCheck >::wireInfo_.

◆ raw() [1/2]

template<typename T , bool SkipTypeCheck = false>

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

inline

Definition at line 846 of file TypedPorts.h.

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

◆ raw() [2/2]

template<typename T , bool SkipTypeCheck = false>

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

inline

Definition at line 847 of file TypedPorts.h.

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

◆ read()

template<typename T , bool SkipTypeCheck = false>

std::unique_ptr< T > esi::TypedReadPort< T, SkipTypeCheck >::read ( )

inline

Blocking typed read in polling mode.

Definition at line 801 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::readAsync().

Referenced by esiaccel.bsp.common.ESI_Manifest_ROM_Wrapper::build(), runCustomServiceDeclChannel(), and runLoopbackI8().

◆ readAsync()

template<typename T , bool SkipTypeCheck = false>

std::future< std::unique_ptr< T > > esi::TypedReadPort< T, SkipTypeCheck >::readAsync ( )

inline

Asynchronous typed read in polling mode.

The returned future yields ownership of the next decoded value.

Definition at line 810 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::Callback, esi::TypedReadPort< T, SkipTypeCheck >::deserializer, esi::TypedReadPort< T, SkipTypeCheck >::Disconnected, esi::TypedReadPort< T, SkipTypeCheck >::mode, and esi::TypedReadPort< T, SkipTypeCheck >::pollingState.

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

◆ resetConnectState()

template<typename T , bool SkipTypeCheck = false>

void esi::TypedReadPort< T, SkipTypeCheck >::resetConnectState ( )

inlineprivate

Definition at line 854 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::deserializer, and esi::TypedReadPort< T, SkipTypeCheck >::pollingState.

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::disconnect().

◆ setMaxDataQueueMsgs()

template<typename T , bool SkipTypeCheck = false>

void esi::TypedReadPort< T, SkipTypeCheck >::setMaxDataQueueMsgs ( uint64_t maxMsgs )

inline

Set the maximum number of decoded typed values buffered in polling mode.

0 means unbounded.

Definition at line 832 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::maxDataQueueMsgs, and esi::TypedReadPort< T, SkipTypeCheck >::pollingState.

Member Data Documentation

◆ deserializer

template<typename T , bool SkipTypeCheck = false>

std::optional<Deserializer> esi::TypedReadPort< T, SkipTypeCheck >::deserializer

private

Definition at line 887 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::emplaceDeserializer(), esi::TypedReadPort< T, SkipTypeCheck >::readAsync(), and esi::TypedReadPort< T, SkipTypeCheck >::resetConnectState().

◆ inner

template<typename T , bool SkipTypeCheck = false>

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

private

Definition at line 883 of file TypedPorts.h.

◆ maxDataQueueMsgs

template<typename T , bool SkipTypeCheck = false>

uint64_t esi::TypedReadPort< T, SkipTypeCheck >::maxDataQueueMsgs = ReadChannelPort::DefaultMaxDataQueueMsgs

private

Definition at line 886 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::setMaxDataQueueMsgs().

◆ mode

template<typename T , bool SkipTypeCheck = false>

Mode esi::TypedReadPort< T, SkipTypeCheck >::mode = Mode::Disconnected

private

Definition at line 885 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::disconnect(), esi::TypedReadPort< T, SkipTypeCheck >::prepareConnect(), esi::TypedReadPort< T, SkipTypeCheck >::readAsync(), and esi::TypedReadPort< T, SkipTypeCheck >::~TypedReadPort().

◆ pollingState

template<typename T , bool SkipTypeCheck = false>

std::optional<PollingState> esi::TypedReadPort< T, SkipTypeCheck >::pollingState

private

Definition at line 888 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::readAsync(), esi::TypedReadPort< T, SkipTypeCheck >::resetConnectState(), and esi::TypedReadPort< T, SkipTypeCheck >::setMaxDataQueueMsgs().

◆ wireInfo_

template<typename T , bool SkipTypeCheck = false>

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

private

Definition at line 884 of file TypedPorts.h.

Referenced by esi::TypedReadPort< T, SkipTypeCheck >::emplaceDeserializer(), and esi::TypedReadPort< T, SkipTypeCheck >::prepareConnect().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Deserializer

◆ PollingState

Member Enumeration Documentation

◆ Mode

Constructor & Destructor Documentation

◆ TypedReadPort() [1/4]

◆ TypedReadPort() [2/4]

◆ TypedReadPort() [3/4]

◆ TypedReadPort() [4/4]

◆ ~TypedReadPort()

Member Function Documentation

◆ connect() [1/3]

◆ connect() [2/3]

◆ connect() [3/3]

◆ disconnect()

◆ emplaceDeserializer()

◆ isConnected()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepareConnect()

◆ raw() [1/2]

◆ raw() [2/2]

◆ read()

◆ readAsync()

◆ resetConnectState()

◆ setMaxDataQueueMsgs()

Member Data Documentation

◆ deserializer

◆ inner

◆ maxDataQueueMsgs

◆ mode

◆ pollingState

◆ wireInfo_