Header Class Reference

Header included in each discovery message containing the version of the discovery protocol, the process UUID of the sender node, the type of message (ADV, SUB, ... ) and optional flags. More...

#include <ignition/transport/Packet.hh>

Public Member Functions
	Header ()=default
	Constructor. More...
	Header (const uint16_t _version, const std::string &_pUuid, const uint8_t _type, const uint16_t _flags=0)
	Constructor. More...
virtual	~Header ()=default
	Destructor. More...
uint16_t	Flags () const
	Get the message flags. More...
int	HeaderLength () const
	Get the header length. More...
size_t	Pack (char *_buffer) const
	Serialize the header. The caller has ownership of the buffer and is responsible for its [de]allocation. More...
std::string	PUuid () const
	Get the process uuid. More...
void	SetFlags (const uint16_t _flags)
	Set the message flags. More...
void	SetPUuid (const std::string &_pUuid)
	Set the process uuid. More...
void	SetType (const uint8_t _type)
	Set the message type. More...
void	SetVersion (const uint16_t _version)
	Set the discovery protocol version. More...
uint8_t	Type () const
	Get the message type. More...
size_t	Unpack (const char *_buffer)
	Unserialize the header. More...
uint16_t	Version () const
	Get the discovery protocol version. More...

Detailed Description

Header included in each discovery message containing the version of the discovery protocol, the process UUID of the sender node, the type of message (ADV, SUB, ... ) and optional flags.

Deprecated:

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

Constructor & Destructor Documentation

Header() [1/2]

Header ( )

default

Constructor.

Header() [2/2]

Header	(	const uint16_t	_version,
		const std::string &	_pUuid,
		const uint8_t	_type,
		const uint16_t	_flags = 0
	)

Constructor.

Parameters

[in]	_version	Version of the discovery protocol.
[in]	_pUuid	Every process has a unique UUID.
[in]	_type	Message type (ADVERTISE, SUBSCRIPTION, ...)
[in]	_flags	Optional flags included in the header.

~Header()

virtual ~Header ( )

virtualdefault

Destructor.

Member Function Documentation

Flags()

uint16_t Flags

(

)

const

Get the message flags.

Returns

Message flags used for compression or other optional features.

See also

SetFlags.

HeaderLength()

int HeaderLength

(

)

const

Get the header length.

Returns

The header length in bytes.

Referenced by AdvertiseMessage< T >::MsgLength().

Pack()

size_t Pack

(

char *

_buffer

)

const

Serialize the header. The caller has ownership of the buffer and is responsible for its [de]allocation.

Parameters

[out]

_buffer

Destination buffer in which the header will be serialized.

Returns

Number of bytes serialized.

Referenced by AdvertiseMessage< T >::Pack().

PUuid()

std::string PUuid

(

)

const

Get the process uuid.

Returns

A unique global identifier for every process.

See also

SetPUuid.

SetFlags()

void SetFlags

(

const uint16_t

_flags

)

Set the message flags.

Parameters

[in]

_flags

Used for enable optional features.

See also

Flags.

SetPUuid()

void SetPUuid

(

const std::string &

_pUuid

)

Set the process uuid.

Parameters

[in]

_pUuid

A unique global identifier for every process.

See also

PUuid.

SetType()

void SetType

(

const uint8_t

_type

)

Set the message type.

Parameters

[in]

_type

Message type (ADVERTISE, SUBSCRIPTION, ...).

See also

Type.

SetVersion()

void SetVersion

(

const uint16_t

_version

)

Set the discovery protocol version.

Parameters

[in]

_version

Discovery protocol version.

See also

Version.

Type()

uint8_t Type

(

)

const

Get the message type.

Returns

Message type (ADVERTISE, SUBSCRIPTION, ...)

See also

SetType.

Unpack()

size_t Unpack

(

const char *

_buffer

)

Unserialize the header.

Parameters

[in]

_buffer

Input buffer with the data to be unserialized.

Version()

uint16_t Version

(

)

const

Get the discovery protocol version.

Returns

The discovery protocol version.

See also

SetVersion.

---

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

• gz/transport/Packet.hh