A ChannelPort which reads data from the accelerator. More...
#include <Ports.h>
Inheritance diagram for esi::ReadChannelPort:
Collaboration diagram for esi::ReadChannelPort:
Public Member Functions | |
| virtual bool | read (MessageData &)=0 |
| Specify a buffer to read into. More... | |
| virtual std::future< MessageData > | readAsync () |
| Asynchronous read. More... | |
| ChannelPort (const Type *type) | |
 Public Member Functions inherited from esi::ChannelPort | |
| ChannelPort (const Type *type) | |
| virtual | ~ChannelPort ()=default |
| virtual void | connect () |
| virtual void | disconnect () |
| const Type * | getType () const |
Detailed Description
A ChannelPort which reads data from the accelerator.
Member Function Documentation
◆ ChannelPort()
◆ read()
|
pure virtual |
Specify a buffer to read into.
Non-blocking. Returns true if message successfully recieved. Basic API, will likely change for performance and functionality reasons.
Referenced by readAsync().
◆ readAsync()
|
virtual |
Asynchronous read.
Returns a future which will be set when the message is recieved. Could this subsume the synchronous read API? The default implementation of this is really bad and should be overridden. It simply polls read in a loop.
Definition at line 46 of file Ports.cpp.
References read().
Referenced by PYBIND11_MODULE().
The documentation for this class was generated from the following files:
