A concrete flat message backed by a single vector of bytes. More...
#include <Common.h>
Public Member Functions | |
| MessageData ()=default | |
| Adopts the data vector buffer. | |
| MessageData (std::span< const uint8_t > data) | |
| MessageData (std::vector< uint8_t > &data) | |
| MessageData (std::vector< uint8_t > &&data) | |
| MessageData (const uint8_t *data, size_t size) | |
| ~MessageData ()=default | |
| const uint8_t * | getBytes () const |
| const std::vector< uint8_t > & | getData () const |
| Get the data as a vector of bytes. | |
| operator const std::vector< uint8_t > & () const | |
| Implicit conversion to a vector/span of bytes, to play nice with other APIs that accept bytearray-like things. | |
| operator std::span< const uint8_t > () const | |
| std::vector< uint8_t > | takeData () |
| Move the data out of this object. | |
| size_t | getSize () const |
| Get the size of the data in bytes. | |
| size_t | size () const |
| bool | empty () const |
| Returns true if this message contains no data. | |
| template<typename T> | |
| const T * | as () const |
| Cast to a type. | |
| std::string | toHex () const |
| Convert the data to a hex string. | |
| size_t | numSegments () const override |
| Number of segments in the message. | |
| Segment | segment (size_t idx) const override |
| Get a segment by index. Throws if the segment has been take()n. | |
| MessageData | toMessageData () const override |
| Flatten all segments into a standard MessageData. | |
| Public Member Functions inherited from esi::SegmentedMessageData | |
| virtual | ~SegmentedMessageData ()=default |
| virtual std::unique_ptr< services::HostMemRegion > | take (size_t segIdx) |
| Optionally called by a backend once it has transmitted segment segIdx, to obtain ownership of the HostMem region backing it (e.g. | |
| size_t | totalSize () const |
| Total size across all segments. | |
| bool | empty () const |
| True if totalSize() == 0. | |
Static Public Member Functions | |
| template<typename T> | |
| static MessageData | from (T &t) |
| Cast from a type to its raw bytes. | |
Private Attributes | |
| std::vector< uint8_t > | data |
Detailed Description
A concrete flat message backed by a single vector of bytes.
This is also a one-segment SegmentedMessageData so flat and segmented messages can flow through the same internal APIs.
Constructor & Destructor Documentation
◆ MessageData() [1/5]
|
default |
Adopts the data vector buffer.
Referenced by from(), and toMessageData().
◆ MessageData() [2/5]
|
inline |
◆ MessageData() [3/5]
|
inline |
◆ MessageData() [4/5]
|
inline |
◆ MessageData() [5/5]
|
inline |
◆ ~MessageData()
|
default |
Member Function Documentation
◆ as()
|
inline |
Cast to a type.
Throws if the size of the data does not match the size of the message. The lifetime of the resulting pointer is tied to the lifetime of this object.
Definition at line 232 of file Common.h.
References data.
Referenced by channelTest(), esi::fromMessageData(), loopbackAddTest(), runArrayFunc(), runArrayFunc(), runLoopbackI8(), runOddStructFunc(), and runStructFunc().
◆ empty()
|
inline |
◆ from()
|
inlinestatic |
Cast from a type to its raw bytes.
Definition at line 242 of file Common.h.
References MessageData().
Referenced by channelTest(), esi::services::TelemetryService::Metric::read(), runOddStructFunc(), and runStructFunc().
◆ getBytes()
|
inline |
Definition at line 208 of file Common.h.
References data.
Referenced by coordTranslateTest(), esi::SerialListTypeDeserializer< T >::decode(), SerialCoordOutputBatch::TypeDeserializer::decode(), esi::fromMessageData(), log(), NB_MODULE(), runArrayProbe(), runBytePatternConst(), runBytePatternEchoEq(), streamingAddTest(), streamingAddTranslatedTest(), and sv2cCosimserverEpTryGet().
◆ getData()
|
inline |
◆ getSize()
|
inline |
Get the size of the data in bytes.
Definition at line 222 of file Common.h.
References data.
Referenced by coordTranslateTest(), esi::SerialListTypeDeserializer< T >::decode(), SerialCoordOutputBatch::TypeDeserializer::decode(), esi::fromMessageData(), esi::cosim::RpcServer::Impl::handleBinaryFrame(), log(), NB_MODULE(), runArrayProbe(), runBytePatternConst(), runBytePatternEchoEq(), runLoopbackI8(), size(), streamingAddTest(), streamingAddTranslatedTest(), and sv2cCosimserverEpTryGet().
◆ numSegments()
|
inlineoverridevirtual |
Number of segments in the message.
Implements esi::SegmentedMessageData.
◆ operator const std::vector< uint8_t > &()
|
inline |
◆ operator std::span< const uint8_t >()
|
inline |
◆ segment()
|
inlineoverridevirtual |
Get a segment by index. Throws if the segment has been take()n.
Implements esi::SegmentedMessageData.
Definition at line 250 of file Common.h.
References data.
◆ size()
|
inline |
Definition at line 223 of file Common.h.
References getSize().
Referenced by MessageData(), and MessageData().
◆ takeData()
|
inline |
◆ toHex()
| std::string MessageData::toHex | ( | ) | const |
◆ toMessageData()
|
inlineoverridevirtual |
Flatten all segments into a standard MessageData.
Reimplemented from esi::SegmentedMessageData.
Definition at line 255 of file Common.h.
References MessageData().
Referenced by esi::ReadChannelPort::connect().
Member Data Documentation
◆ data
|
private |
Definition at line 258 of file Common.h.
Referenced by as(), empty(), tests.integration.test_hostmem_read._Dut::expected(), getBytes(), getData(), getSize(), MessageData(), MessageData(), MessageData(), MessageData(), operator const std::vector< uint8_t > &(), operator std::span< const uint8_t >(), segment(), takeData(), and toHex().
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/Common.h
- /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/cpp/lib/Common.cpp
Generated on for CIRCT by
1.15.0