HF::Core::GroupManagement::InfoResponse Struct Reference

Message payload for a HF::GroupManagement::GET_INFO_CMD response. More...

#include <group_management.h>

Inheritance diagram for HF::Core::GroupManagement::InfoResponse:

Collaboration diagram for HF::Core::GroupManagement::InfoResponse:

Public Member Functions
	InfoResponse (const std::string &name, std::vector< Member > &members)
	Constructor. More...
	InfoResponse (Common::Result code, const std::string &name, std::vector< Member > &members)
	Constructor. More...
	InfoResponse ()
	Empty 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...
Public Member Functions inherited from HF::Protocol::Response
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...

Static Public Attributes
static constexpr uint16_t	min_size = Protocol::Response::min_size
	Minimum pack/unpack required data size.
Static Public Attributes inherited from HF::Protocol::Response
static constexpr uint16_t	min_size = sizeof(uint8_t)
	Minimum number of bytes required by this message.

Detailed Description

Message payload for a HF::GroupManagement::GET_INFO_CMD response.

Definition at line 502 of file group_management.h.

Constructor & Destructor Documentation

InfoResponse() [1/3]

HF::Core::GroupManagement::InfoResponse::InfoResponse ( const std::string &  name, std::vector< Member > &  members  )

inline

Constructor.

Parameters

name	Group Name
members	Member vector

Definition at line 513 of file group_management.h.

                                                                           :
               Protocol::Response(), name(name), members(members)
            {}

InfoResponse() [2/3]

HF::Core::GroupManagement::InfoResponse::InfoResponse ( Common::Result  code, const std::string &  name, std::vector< Member > &  members  )

inline

Constructor.

Parameters

code	response code.
name	group Name
members	members vector

Definition at line 524 of file group_management.h.

                                                    :
               Protocol::Response(code), name(name), members(members)
            {}

InfoResponse() [3/3]

HF::Core::GroupManagement::InfoResponse::InfoResponse ( )

inline

Empty Constructor.

Mainly to use with the unpack function.

Definition at line 534 of file group_management.h.

            {}

Member Function Documentation

pack()

uint16_t HF::Core::GroupManagement::InfoResponse::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::InfoResponse::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::InfoResponse::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.

---

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

• group_management.h