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...

Detailed Description

Subscription packet used in the discovery protocol for requesting information about a given topic.

Deprecated:

This class is deprecated. Discovery uses the gz::msgs::Discovery message.

Constructor & Destructor Documentation

SubscriptionMsg() [1/2]

SubscriptionMsg ( )

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

Get the message header.

Returns

Reference to the message header.

See also

SetHeader.

MsgLength()

size_t MsgLength

(

)

const

Get the total length of the message.

Returns

Return the length of the message in bytes.

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.

SetHeader()

void SetHeader

(

const transport::Header &

_header

)

Set the header of the message.

Parameters

[in]

_header

Message header.

See also

Header.

SetTopic()

void SetTopic

(

const std::string &

_topic

)

Set the topic.

Parameters

[in]

_topic

Topic name.

See also

Topic.

Topic()

std::string Topic

(

)

const

Get the topic.

Returns

Topic name.

See also

SetTopic.

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.

---

The documentation for this class was generated from the following file:

• gz/transport/Packet.hh