Skip to main content

MessageRequest Struct

Request transmission of a specified message type, (MessageType::MESSAGE_REQUEST, version 1). More...

Declaration​

struct point_one::fusion_engine::messages::MessageRequest { ... }

Included Headers​

#include <point_one/fusion_engine/messages/control.h>

Base struct​

structMessagePayload

The base class for all message payloads. More...

Public Member Attributes Index​

MessageTypemessage_type = MessageType::INVALID

The desired message type. More...

Public Static Attributes Index​

static constexpr MessageTypeMESSAGE_TYPE = MessageType::MESSAGE_REQUEST
static constexpr uint8_tMESSAGE_VERSION = 0

Description​

Request transmission of a specified message type, (MessageType::MESSAGE_REQUEST, version 1).

On success, the device will output the requested message type.

Not all message types may be requested explicitly. If a message type cannot be requested on demand or is not supported, the device will respond with a Response::UNSUPPORTED_FEATURE message.

info

The generated response may not immediately follow the request if other outbound messages are already enqueued to be sent.

Expected Response​

The requested message type, or CommandResponseMessage on error.

Definition at line 79 of file control.h.

Public Member Attributes​

message_type​

MessageType point_one::fusion_engine::messages::MessageRequest::message_type = MessageType::INVALID

The desired message type.

Definition at line 84 of file control.h.

84 MessageType message_type = MessageType::INVALID;

Public Static Attributes​

MESSAGE_TYPE​

constexpr MessageType point_one::fusion_engine::messages::MessageRequest::MESSAGE_TYPE = MessageType::MESSAGE_REQUEST
 constexpr static

Definition at line 80 of file control.h.

80 static constexpr MessageType MESSAGE_TYPE = MessageType::MESSAGE_REQUEST;

MESSAGE_VERSION​

constexpr uint8_t point_one::fusion_engine::messages::MessageRequest::MESSAGE_VERSION = 0
 constexpr static

Definition at line 81 of file control.h.

81 static constexpr uint8_t MESSAGE_VERSION = 0;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.