This class represents the message payload of a HF::Message::SET_ATTR_PACK_REQ or HF::Message::SET_ATTR_PACK_RESP_REQ message. More...

#include <attributes.h>

Collaboration diagram for HF::Protocol::SetAttributePack::Request:

Public Member Functions
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
HF::Attributes::List	attributes
	List containing the attributes to send. More...

uint8_t	count
	Unpack attribute count. More...

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

Detailed Description

This class represents the message payload of a HF::Message::SET_ATTR_PACK_REQ or HF::Message::SET_ATTR_PACK_RESP_REQ message.

Definition at line 1016 of file attributes.h.

Member Function Documentation

◆ pack()

uint16_t HF::Protocol::SetAttributePack::Request::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::Protocol::SetAttributePack::Request::size ( ) const

Number bytes needed to serialize the message.

Returns: number of bytes the message requires to be serialized.

◆ unpack()

uint16_t HF::Protocol::SetAttributePack::Request::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.

Warning: This method read ONLY the number of attribute values that are in the array and palces that value into count. Further processing MUST be done to read the attribute values.

Field Documentation

◆ attributes

HF::Attributes::List HF::Protocol::SetAttributePack::Request::attributes

List containing the attributes to send.

Definition at line 1018 of file attributes.h.

◆ count

uint8_t HF::Protocol::SetAttributePack::Request::count

Unpack attribute count.

Warning: This value will not be used as the number of attributes, when packing the request.

Definition at line 1026 of file attributes.h.

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

attributes.h

Public Member Functions

Data Fields

Static Public Attributes