A telemetry port which gets attached to a service port. More...
#include <Services.h>
Public Member Functions | |
| void | connect () |
| Connect to a particular telemetry port. | |
| std::future< MessageData > | read () |
| virtual std::optional< std::string > | toString () const override |
 Public Member Functions inherited from esi::services::ServicePort | |
| virtual | ~ServicePort ()=default |
| BundlePort (AppID id, const BundleType *type, PortMap channels) | |
| Construct a port. | |
| Public Member Functions inherited from esi::BundlePort | |
| BundlePort (AppID id, const BundleType *type, PortMap channels) | |
| Construct a port. | |
| virtual | ~BundlePort ()=default |
| AppID | getID () const |
| Get the ID of the port. | |
| WriteChannelPort & | getRawWrite (const std::string &name) const |
| Get access to the raw byte streams of a channel. | |
| ReadChannelPort & | getRawRead (const std::string &name) const |
| const PortMap & | getChannels () const |
| template<typename T > | |
| T * | getAs () const |
| Cast this Bundle port to a subclass which is actually useful. | |
| bool | poll () |
Calls poll on all channels in the bundle and returns true if any of them returned true. | |
Static Public Member Functions | |
| static Telemetry * | get (AppID id, BundleType *type, WriteChannelPort &get, ReadChannelPort &data) |
| Static Public Member Functions inherited from esi::BundlePort | |
| static bool | isWrite (BundleType::Direction bundleDir) |
| Compute the direction of a channel given the bundle direction and the bundle port's direction. | |
Private Member Functions | |
| Telemetry (AppID id, const BundleType *type, PortMap channels) | |
Private Attributes | |
| WriteChannelPort * | get_req |
| ReadChannelPort * | data |
Friends | |
| class | TelemetryService |
Additional Inherited Members | |
| Protected Attributes inherited from esi::BundlePort | |
| AppID | id |
| const BundleType * | type |
| PortMap | channels |
Detailed Description
A telemetry port which gets attached to a service port.
Definition at line 355 of file Services.h.
Constructor & Destructor Documentation
◆ Telemetry()
|
private |
Definition at line 293 of file Services.cpp.
Member Function Documentation
◆ connect()
| void TelemetryService::Telemetry::connect | ( | ) |
Connect to a particular telemetry port.
The bundle should have two channels – get and data. Get should have type 'i0' and data can be anything.
Definition at line 305 of file Services.cpp.
Referenced by hostmemTest(), and PYBIND11_MODULE().
◆ get()
|
static |
Definition at line 298 of file Services.cpp.
◆ read()
| std::future< MessageData > TelemetryService::Telemetry::read | ( | ) |
Definition at line 319 of file Services.cpp.
References empty.
Referenced by hostmemTest(), and PYBIND11_MODULE().
◆ toString()
|
inlineoverridevirtual |
Reimplemented from esi::services::ServicePort.
Definition at line 366 of file Services.h.
References esi::BundleType::findChannel(), esi::Type::getID(), and esi::BundlePort::type.
Friends And Related Symbol Documentation
◆ TelemetryService
|
friend |
Definition at line 356 of file Services.h.
Member Data Documentation
◆ data
|
private |
Definition at line 375 of file Services.h.
◆ get_req
|
private |
Definition at line 374 of file Services.h.
The documentation for this class was generated from the following files:
- /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/include/esi/Services.h
- /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Services.cpp
