HF::Core::DeviceManagement::DeregisterMessage Struct Reference

De-register command message. More...

#include <device_management.h>

Collaboration diagram for HF::Core::DeviceManagement::DeregisterMessage:

Public Member Functions
	DeregisterMessage (uint16_t address=0)
	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
uint16_t	address
	Address of the device to de-register. More...

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

Detailed Description

De-register command message.

Definition at line 315 of file device_management.h.

Constructor & Destructor Documentation

DeregisterMessage()

HF::Core::DeviceManagement::DeregisterMessage::DeregisterMessage ( uint16_t  address = 0 )

inline

Constructor.

Parameters

[in]

address

device address to de-register.

Definition at line 324 of file device_management.h.

                                                   :
               address(address)
            {}

Member Function Documentation

pack()

uint16_t HF::Core::DeviceManagement::DeregisterMessage::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::DeviceManagement::DeregisterMessage::size

(

)

const

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

unpack()

uint16_t HF::Core::DeviceManagement::DeregisterMessage::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

address

uint16_t HF::Core::DeviceManagement::DeregisterMessage::address

Address of the device to de-register.

Definition at line 317 of file device_management.h.

---

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

• device_management.h