Wire/shared-memory header of a ControlMessage; any payload follows immediately after. More...

#include <ControlMessage.h>

Public Attributes
uint32	size
	Total block size in bytes (header + payload).
uint32	cid
	Object id, always CONTROLMESSAGEID for a valid message.
uint64	time
	Creation time in microseconds since epoch.
uint64	from
	Sender id (wider than DataMessage's: can encode node+component).
uint64	to
	Addressee id.
uint16	command
	Command code — what the receiver should do.
uint16	status
	Status/result code, typically filled in by the receiver.

Detailed Description

Wire/shared-memory header of a ControlMessage; any payload follows immediately after.

Warning: Binary contract — do not change field order or sizes.

Definition at line 26 of file ControlMessage.h.

Member Data Documentation

◆ cid

uint32 cmlabs::ControlMessageHeader::cid

Object id, always CONTROLMESSAGEID for a valid message.

auto

Definition at line 28 of file ControlMessage.h.

◆ command

uint16 cmlabs::ControlMessageHeader::command

Command code — what the receiver should do.

user

Definition at line 33 of file ControlMessage.h.

◆ from

uint64 cmlabs::ControlMessageHeader::from

Sender id (wider than DataMessage's: can encode node+component).

Definition at line 30 of file ControlMessage.h.

◆ size

uint32 cmlabs::ControlMessageHeader::size

Total block size in bytes (header + payload).

auto

Definition at line 27 of file ControlMessage.h.

Referenced by cmlabs::ControlMessage::ControlMessage().

◆ status

uint16 cmlabs::ControlMessageHeader::status

Status/result code, typically filled in by the receiver.

user

Definition at line 34 of file ControlMessage.h.

◆ time

uint64 cmlabs::ControlMessageHeader::time

Creation time in microseconds since epoch.

auto/api

Definition at line 29 of file ControlMessage.h.

◆ to

uint64 cmlabs::ControlMessageHeader::to

Addressee id.

Definition at line 31 of file ControlMessage.h.

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

/home/ubuntu/c/partner/psyclone2/CMSDK/include/ControlMessage.h

Public Attributes