Response message payload for a Scheduling::DEFINE_EVENT_CMD request. More...

#include <scheduling.h>

Inheritance diagram for HF::Core::Scheduling::DefineEventResponse:

Collaboration diagram for HF::Core::Scheduling::DefineEventResponse:

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...

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...

Data Fields
uint8_t	event_id
	Event ID. More...

Additional Inherited Members
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

Response message payload for a Scheduling::DEFINE_EVENT_CMD request.

Definition at line 314 of file scheduling.h.

Member Function Documentation

◆ pack()

uint16_t HF::Core::Scheduling::DefineEventResponse::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::Scheduling::DefineEventResponse::size ( ) const

inline

Number bytes needed to serialize the message.

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

Definition at line 324 of file scheduling.h.

References HF::Protocol::Response::min_size, and HF::Common::OK.

             {
                if (code != Common::Result::OK)
                {
                   return min_size;
                }
 
                return min_size + sizeof(uint8_t);
             }

◆ unpack()

uint16_t HF::Core::Scheduling::DefineEventResponse::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

◆ event_id

uint8_t HF::Core::Scheduling::DefineEventResponse::event_id

Event ID.

Definition at line 316 of file scheduling.h.

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

scheduling.h

Public Member Functions

Data Fields