HF::Core::GroupManagement::CreateMessage Struct Reference

Message payload for a HF::GroupManagement::CREATE_CMD request. More...

#include <group_management.h>

Collaboration diagram for HF::Core::GroupManagement::CreateMessage:

Public Member Functions
	CreateMessage (std::string name="")
	Constructor. More...
uint16_t	size () const
	Number bytes needed to serialize the message. More...
uint16_t	pack (Common::ByteArray &array, uint16_t offset=0) const
	Write the object on to a ByteArray so it can be sent over the network. More...
uint16_t	unpack (const Common::ByteArray &array, uint16_t offset=0)
	Read a message from a ByteArray. More...

Data Fields
std::string	name
	Group Name. More...

Static Public Attributes
static constexpr uint16_t	min_size = sizeof(uint8_t)
	Minimum pack/unpack required data size.

Detailed Description

Message payload for a HF::GroupManagement::CREATE_CMD request.

Definition at line 360 of file group_management.h.

Constructor & Destructor Documentation

CreateMessage()

HF::Core::GroupManagement::CreateMessage::CreateMessage ( std::string  name = "" )

inline

Constructor.

Parameters

[in]

name

group's name.

Definition at line 369 of file group_management.h.

                                              :
               name(name)
            {}

Member Function Documentation

pack()

uint16_t HF::Core::GroupManagement::CreateMessage::pack	(	Common::ByteArray &	array,
		uint16_t	offset = 0
	)		const

Write the object on to a ByteArray so it can be sent over the network.

The buffer passed in MUST have enough size to hold the serialized object, e.g.,

Serializable obj;
ByteArray payload(obj.size());
obj.pack(payload);

Parameters

[in,out]	array	ByteArray reference to write the object to.
[in]	offset	offset to start writing to.

Returns

the number of bytes written.

size()

uint16_t HF::Core::GroupManagement::CreateMessage::size

(

)

const

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

unpack()

uint16_t HF::Core::GroupManagement::CreateMessage::unpack	(	const Common::ByteArray &	array,
		uint16_t	offset = 0
	)

Read a message from a ByteArray.

Parameters

[in]	array	ByteArray reference to read the message from.
[in]	offset	offset to start reading from.

Returns

the number of bytes read.

Field Documentation

name

std::string HF::Core::GroupManagement::CreateMessage::name

Group Name.

Definition at line 362 of file group_management.h.

---

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

• group_management.h