Skip to main content

ShutdownRequest Struct

Perform a device shutdown (MessageType::SHUTDOWN_REQUEST, version 1). More...

Declaration​

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

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​

uint64_tshutdown_flags = 0

A bitmask of flags associated with the event. More...

Public Static Attributes Index​

static constexpr MessageTypeMESSAGE_TYPE = MessageType::SHUTDOWN_REQUEST
static constexpr uint8_tMESSAGE_VERSION = 0
static constexpr uint64_tSTOP_CURRENT_LOG = 0x0000000000000002

If a log is being generated, end that log. More...

static constexpr uint64_tSTOP_ENGINE = 0x0000000000000001

Stop navigation engine and flush state to non-volatile storage. More...

Description​

Perform a device shutdown (MessageType::SHUTDOWN_REQUEST, version 1).

Expected Response​

The device will respond with a CommandResponseMessage indicating whether or not the request succeeded.

Definition at line 334 of file control.h.

Public Member Attributes​

shutdown_flags​

uint64_t point_one::fusion_engine::messages::ShutdownRequest::shutdown_flags = 0

A bitmask of flags associated with the event.

info

For backwards compatibility, a value of 0 is treated as if the STOP_ENGINE bit is set (1).

Definition at line 353 of file control.h.

353 uint64_t shutdown_flags = 0;

Public Static Attributes​

MESSAGE_TYPE​

constexpr MessageType point_one::fusion_engine::messages::ShutdownRequest::MESSAGE_TYPE = MessageType::SHUTDOWN_REQUEST
 constexpr static

Definition at line 335 of file control.h.

335 static constexpr MessageType MESSAGE_TYPE = MessageType::SHUTDOWN_REQUEST;

MESSAGE_VERSION​

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

Definition at line 336 of file control.h.

336 static constexpr uint8_t MESSAGE_VERSION = 0;

STOP_CURRENT_LOG​

constexpr uint64_t point_one::fusion_engine::messages::ShutdownRequest::STOP_CURRENT_LOG = 0x0000000000000002
 constexpr static

If a log is being generated, end that log.

Definition at line 345 of file control.h.

345 static constexpr uint64_t STOP_CURRENT_LOG = 0x0000000000000002;

STOP_ENGINE​

constexpr uint64_t point_one::fusion_engine::messages::ShutdownRequest::STOP_ENGINE = 0x0000000000000001
 constexpr static

Stop navigation engine and flush state to non-volatile storage.

Definition at line 341 of file control.h.

341 static constexpr uint64_t STOP_ENGINE = 0x0000000000000001;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.