A ChannelPort which sends data to the accelerator. More...

#include <Ports.h>

Inheritance diagram for esi::WriteChannelPort:

[legend]

Collaboration diagram for esi::WriteChannelPort:

[legend]

Public Member Functions
virtual void	connect (std::optional< unsigned > bufferSize=std::nullopt) override
	Set up a connection to the accelerator.

virtual void	disconnect () override

virtual bool	isConnected () const override

virtual void	write (const MessageData &)=0
	A very basic blocking write API.

virtual bool	tryWrite (const MessageData &data)=0
	A basic non-blocking write API.

	ChannelPort (const Type *type)

Public Member Functions inherited from esi::ChannelPort
	ChannelPort (const Type *type)

virtual	~ChannelPort ()

bool	poll ()
	Poll for incoming data.

const Type *	getType () const

Private Attributes
volatile bool	connected = false

Additional Inherited Members
Protected Member Functions inherited from esi::ChannelPort
virtual bool	pollImpl ()
	Method called by poll() to actually poll the channel if the channel is connected.

virtual void	connectImpl (std::optional< unsigned > bufferSize)
	Called by all connect methods to let backends initiate the underlying connections.

Protected Attributes inherited from esi::ChannelPort
const Type *	type

Detailed Description

A ChannelPort which sends data to the accelerator.

Definition at line 77 of file Ports.h.

Member Function Documentation

◆ ChannelPort()

esi::ChannelPort::ChannelPort ( const Type * type )

inline

Definition at line 38 of file Ports.h.

◆ connect()

virtual void esi::WriteChannelPort::connect ( std::optional< unsigned > bufferSize = std::nullopt )

inlineoverridevirtual

Set up a connection to the accelerator.

The buffer size is optional and should be considered merely a hint. Individual implementations use it however they like. The unit is number of messages of the port type.

Implements esi::ChannelPort.

Reimplemented in esi::UnknownWriteChannelPort.

Definition at line 82 of file Ports.h.

References connected, and esi::ChannelPort::connectImpl().

◆ disconnect()

virtual void esi::WriteChannelPort::disconnect ( )

inlineoverridevirtual

Implements esi::ChannelPort.

Definition at line 86 of file Ports.h.

References connected.

◆ isConnected()

virtual bool esi::WriteChannelPort::isConnected ( ) const

inlineoverridevirtual

Implements esi::ChannelPort.

Definition at line 87 of file Ports.h.

References connected.

◆ tryWrite()

virtual bool esi::WriteChannelPort::tryWrite ( const MessageData & data )

pure virtual

A basic non-blocking write API.

Returns true if the data was written. It is invalid for backends to always return false (i.e. backends must eventually ensure that writes may succeed).

Implemented in esi::UnknownWriteChannelPort.

Referenced by PYBIND11_MODULE().