HF::Interfaces::Alert::Message Struct Reference

Payload for the Status command. More...

#include <alert.h>

Collaboration diagram for HF::Interfaces::Alert::Message:

Public Member Functions
	Message (uint16_t type=0, uint32_t state=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	type
	Unit Type that generated the message. More...
uint32_t	state
	Current state of the server. More...

Static Public Attributes
static constexpr uint16_t	min_size
	Minimum pack/unpack required data size.

Detailed Description

Payload for the Status command.

Definition at line 86 of file alert.h.

Constructor & Destructor Documentation

Message()

HF::Interfaces::Alert::Message::Message	(	uint16_t	type = 0,
		uint32_t	state = 0
	)

Constructor.

Parameters

[in]	type	unit that generated this message.
[in]	state	state to sent to the client.

Member Function Documentation

pack()

uint16_t HF::Interfaces::Alert::Message::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::Interfaces::Alert::Message::size

(

)

const

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

unpack()

uint16_t HF::Interfaces::Alert::Message::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

state

uint32_t HF::Interfaces::Alert::Message::state

Current state of the server.

Definition at line 93 of file alert.h.

type

uint16_t HF::Interfaces::Alert::Message::type

Unit Type that generated the message.

Definition at line 92 of file alert.h.

---

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

• alert.h