HF::Protocol::SetAttributePack::Response Struct Reference

This class represents the payload of a HF::Message::SET_ATTR_PACK_RES message. More...

#include <attributes.h>

Collaboration diagram for HF::Protocol::SetAttributePack::Response:

Data Structures
struct	Result
	Set attribute operation result. More...

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
results_t	results
	Response results. More...
uint8_t	count
	Unpack the results 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 payload of a HF::Message::SET_ATTR_PACK_RES message.

Definition at line 1052 of file attributes.h.

Member Function Documentation

pack()

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

inline

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Definition at line 1126 of file attributes.h.

References HF::Protocol::SetAttributePack::Response::Result::min_size, min_size, and results.

            {
               uint16_t result = min_size;

               result += results.size() * Result::min_size;

               return result;
            }

unpack()

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

count

uint8_t HF::Protocol::SetAttributePack::Response::count

Unpack the results count.

Warning

This value will not be used as the number of results, when packing the response.

Definition at line 1120 of file attributes.h.

results

results_t HF::Protocol::SetAttributePack::Response::results

Response results.

Definition at line 1112 of file attributes.h.

Referenced by size().

---

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

• attributes.h