MeshUtil::cs_mesh_queue_item_t Struct Reference

Struct to queue an item. More...

#include <cs_MeshCommon.h>

Collaboration diagram for MeshUtil::cs_mesh_queue_item_t:

Public Attributes
cs_mesh_queue_item_meta_data_t	metaData = {}
	Metadata. More...
bool	acked = false
	Whether the message should be acked. More...
bool	broadcast = true
	Whether the message should be broadcasted. More...
bool	doNotRelay = false
	Whether this message should be sent to direct neighbours only. More...
cs_control_cmd_t	controlCommand = CTRL_CMD_UNKNOWN
	If this mesh message is sent because of a Mesh command, then set this field to the control command payload of that mesh command. More...
uint8_t	numStoneIds = 0
	Number of target stone IDs. More...
stone_id_t *	stoneIdsPtr = nullptr
	Pointer to the list of target stone IDs. More...
cs_data_t	msgPayload = {}
	The message payload. More...

Detailed Description

Struct to queue an item.

Data is temporary, so has to be copied.

Member Data Documentation

acked

bool MeshUtil::cs_mesh_queue_item_t::acked = false

Whether the message should be acked.

broadcast

bool MeshUtil::cs_mesh_queue_item_t::broadcast = true

Whether the message should be broadcasted.

controlCommand

cs_control_cmd_t MeshUtil::cs_mesh_queue_item_t::controlCommand = CTRL_CMD_UNKNOWN

If this mesh message is sent because of a Mesh command, then set this field to the control command payload of that mesh command.

It is used to send back the result of the mesh command.

doNotRelay

bool MeshUtil::cs_mesh_queue_item_t::doNotRelay = false

Whether this message should be sent to direct neighbours only.

metaData

cs_mesh_queue_item_meta_data_t MeshUtil::cs_mesh_queue_item_t::metaData = {}

Metadata.

msgPayload

cs_data_t MeshUtil::cs_mesh_queue_item_t::msgPayload = {}

The message payload.

numStoneIds

uint8_t MeshUtil::cs_mesh_queue_item_t::numStoneIds = 0

Number of target stone IDs.

stoneIdsPtr

stone_id_t* MeshUtil::cs_mesh_queue_item_t::stoneIdsPtr = nullptr

Pointer to the list of target stone IDs.

---

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

• source/include/mesh/cs_MeshCommon.h