Detailed Description

Notification of a system event for logging purposes (MessageType::EVENT_NOTIFICATION, version 1.0).

This message is followed by a string describing the event or additional binary content, depending on the type of event. The length of the description is event_description_len_bytes. Strings are not null-terminated.

{MessageHeader, EventNotificationMessage, "Description"}

Definition at line 213 of file device.h.

Inheritance diagram for point_one::fusion_engine::messages::EventNotificationMessage:

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

Public Types
enum	EventType : uint8_t { EventType::LOG = 0, EventType::RESET = 1, EventType::CONFIG_CHANGE = 2, EventType::COMMAND = 3, EventType::COMMAND_RESPONSE = 4 }

Static Public Member Functions
static P1_CONSTEXPR_FUNC const char *	to_string (EventType type)

Public Attributes
uint16_t	event_description_len_bytes = 0
	The number of bytes in the event description string. More...

uint64_t	event_flags = 0
	A bitmask of flags associated with the event. More...

int64_t	system_time_ns = 0
	The system time when the event occurred (in ns). More...

EventType	type = EventType::LOG
	The type of event that occurred. More...

Static Public Attributes
static constexpr MessageType	MESSAGE_TYPE = MessageType::EVENT_NOTIFICATION

static constexpr uint8_t	MESSAGE_VERSION = 0

Member Enumeration Documentation

◆ EventType

enum point_one::fusion_engine::messages::EventNotificationMessage::EventType : uint8_t

strong

Enumerator
LOG	Event containing a logged message string from the device.
RESET	Event indicating a device reset occurred. The event flags will be set to the requested reset bitmask, if applicable (see ResetRequest). The payload will contain a string describing the cause of the reset.
CONFIG_CHANGE	Notification that the user configuration has been changed. Intended for diagnostic purposes.
COMMAND	Notification that the user performed a command (e.g., configuration request, fault injection enable/disable).
COMMAND_RESPONSE	Record containing the response to a user command. Response events are not output on the interface on which the command was received; that interface will receive the response itself.

Definition at line 214 of file device.h.

Member Function Documentation

◆ to_string()

static P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::EventNotificationMessage::to_string ( EventType type )

inlinestatic

Definition at line 243 of file device.h.

Member Data Documentation

◆ event_description_len_bytes

uint16_t point_one::fusion_engine::messages::EventNotificationMessage::event_description_len_bytes = 0

The number of bytes in the event description string.

Definition at line 280 of file device.h.

◆ event_flags

uint64_t point_one::fusion_engine::messages::EventNotificationMessage::event_flags = 0

A bitmask of flags associated with the event.

Definition at line 277 of file device.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::EventNotificationMessage::MESSAGE_TYPE = MessageType::EVENT_NOTIFICATION

staticconstexpr

Definition at line 265 of file device.h.

◆ MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::EventNotificationMessage::MESSAGE_VERSION = 0

staticconstexpr

Definition at line 266 of file device.h.

◆ system_time_ns

int64_t point_one::fusion_engine::messages::EventNotificationMessage::system_time_ns = 0

The system time when the event occurred (in ns).

Definition at line 274 of file device.h.

◆ type

EventType point_one::fusion_engine::messages::EventNotificationMessage::type = EventType::LOG

The type of event that occurred.

Definition at line 269 of file device.h.

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

src/point_one/fusion_engine/messages/device.h