SubscriptionMsg Class Reference
Subscription packet used in the discovery protocol for requesting information about a given topic. More...
#include <ignition/transport/Packet.hh>
Public Member Functions | |
SubscriptionMsg ()=default | |
Constructor. More... | |
SubscriptionMsg (const transport::Header &_header, const std::string &_topic) | |
Constructor. More... | |
transport::Header | Header () const |
Get the message header. More... | |
size_t | MsgLength () const |
Get the total length of the message. More... | |
size_t | Pack (char *_buffer) const |
Serialize the subscription message. More... | |
void | SetHeader (const transport::Header &_header) |
Set the header of the message. More... | |
void | SetTopic (const std::string &_topic) |
Set the topic. More... | |
std::string | Topic () const |
Get the topic. More... | |
size_t | Unpack (const char *_buffer) |
Unserialize a stream of bytes into a Sub. More... | |
Friends | |
std::ostream & | operator<< (std::ostream &_out, const SubscriptionMsg &_msg) |
Stream insertion operator. More... | |
Detailed Description
Subscription packet used in the discovery protocol for requesting information about a given topic.
Constructor & Destructor Documentation
◆ SubscriptionMsg() [1/2]
|
default |
Constructor.
◆ SubscriptionMsg() [2/2]
SubscriptionMsg | ( | const transport::Header & | _header, |
const std::string & | _topic | ||
) |
Constructor.
- Parameters
-
[in] _header Message header. [in] _topic Topic name.
Member Function Documentation
◆ Header()
transport::Header Header | ( | ) | const |
◆ MsgLength()
size_t MsgLength | ( | ) | const |
Get the total length of the message.
- Returns
- Return the length of the message in bytes.
Referenced by Discovery< Pub >::WaitForInit().
◆ Pack()
size_t Pack | ( | char * | _buffer | ) | const |
Serialize the subscription message.
- Parameters
-
[out] _buffer Buffer where the message will be serialized.
- Returns
- The length of the serialized message in bytes.
Referenced by Discovery< Pub >::WaitForInit().
◆ SetHeader()
void SetHeader | ( | const transport::Header & | _header | ) |
◆ SetTopic()
void SetTopic | ( | const std::string & | _topic | ) |
◆ Topic()
std::string Topic | ( | ) | const |
◆ Unpack()
size_t Unpack | ( | const char * | _buffer | ) |
Unserialize a stream of bytes into a Sub.
- Parameters
-
[out] _buffer Unpack the body from the buffer.
- Returns
- The number of bytes from the body.
Referenced by Discovery< Pub >::WaitForInit().
Friends And Related Function Documentation
◆ operator<<
|
friend |
Stream insertion operator.
- Parameters
-
[out] _out The output stream. [in] _msg SubscriptionMsg message to write to the stream.
The documentation for this class was generated from the following file: