Input/Output Interface And Message Rate Control
Messages for controlling device output (e.g., define TCP server parameters, configure message output rates). More...
Classes Index
| struct | GetMessageRate |
|
Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1). More... | |
| struct | InterfaceConfigSubmessage |
|
I/O interface parameter configuration submessage (used when sending a SetConfigMessage or GetConfigMessage for ConfigType::INTERFACE_CONFIG). More... | |
| struct | InterfaceID |
|
Identifier for an I/O interface. More... | |
| struct | MessageRateResponse |
|
Response to a GetMessageRate request (MessageType::MESSAGE_RATE_RESPONSE, version 1.1). More... | |
| struct | MessageRateResponseEntry |
|
An element of a MessageRateResponse message. More... | |
| struct | SetMessageRate |
|
Set the output rate for the requested message types (MessageType::SET_MESSAGE_RATE, version 1). More... | |
| struct | SupportedIOInterfacesMessage |
|
A list of transport interfaces supported by the device (MessageType::SUPPORTED_IO_INTERFACES, version 1). More... | |
Enumerations Index
| enum class | InterfaceConfigType : uint8_t { ... } |
|
An identifier for the contents of a output interface configuration submessage. More... | |
| enum class | MessageRate : uint8_t { ... } |
|
The output rate for a message type on an interface. More... | |
| enum class | NmeaMessageType : uint16_t { ... } |
|
Integer ID for NMEA messages. More... | |
| enum class | ProtocolType : uint8_t { ... } |
|
The framing protocol of a message. More... | |
| enum class | SocketType : uint8_t { ... } |
|
The socket type specifying how data is transmitted for UNIX domain sockets. More... | |
| enum class | TransportDirection : uint8_t { ... } |
|
The direction (client/server) for an individual interface. More... | |
| enum class | TransportType : uint8_t { ... } |
|
Type of I/O interface transport. More... | |
Operators Index
| p1_ostream & | operator<< (p1_ostream &stream, const InterfaceID &val) |
|
InterfaceID stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, InterfaceConfigType type) |
|
InterfaceConfigType stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, MessageRate val) |
|
MessageRate stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, NmeaMessageType val) |
|
NmeaMessageType stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, ProtocolType val) |
|
ProtocolType stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, SocketType val) |
|
SocketType stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, TransportDirection val) |
|
TransportDirection stream operator. More... | |
| p1_ostream & | operator<< (p1_ostream &stream, TransportType val) |
|
TransportType stream operator. More... | |
Functions Index
| P1_CONSTEXPR_FUNC const char * | to_string (InterfaceConfigType type) |
|
Get a human-friendly string name for the specified ConfigType. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (MessageRate value) |
|
Get a human-friendly string name for the specified MessageRate. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (NmeaMessageType value) |
|
Get a human-friendly string name for the specified NmeaMessageType. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (ProtocolType val) |
|
Get a human-friendly string name for the specified ProtocolType. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (SocketType val) |
|
Get a human-friendly string name for the specified SocketType. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (TransportDirection val) |
|
Get a human-friendly string name for the specified TransportDirection. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (TransportType val) |
|
Get a human-friendly string name for the specified TransportType. More... | |
Description
Messages for controlling device output (e.g., define TCP server parameters, configure message output rates).
Enumerations
InterfaceConfigType
| strong |
An identifier for the contents of a output interface configuration submessage.
- Enumeration values
See also InterfaceConfigSubmessage.
Definition at line 1531 of file configuration.h.
MessageRate
| strong |
The output rate for a message type on an interface.
- Enumeration values
-
OFF Disable output of this message (= 0) ON_CHANGE Output this message each time a new value is available (= 1) MAX_RATE Alias for MessageRate::ON_CHANGE (= 1) INTERVAL_10_MS Output this message every 10 milliseconds (= 2) INTERVAL_20_MS Output this message every 20 milliseconds (= 3) INTERVAL_40_MS Output this message every 40 milliseconds (= 4) INTERVAL_50_MS Output this message every 50 milliseconds (= 5) INTERVAL_100_MS Output this message every 100 milliseconds (= 6) INTERVAL_200_MS Output this message every 200 milliseconds (= 7) INTERVAL_500_MS Output this message every 500 milliseconds (= 8) INTERVAL_1_S Output this message every second (= 9) INTERVAL_2_S Output this message every 2 seconds (= 10) INTERVAL_5_S Output this message every 5 seconds (= 11) INTERVAL_10_S Output this message every 10 seconds (= 12) INTERVAL_30_S Output this message every 30 seconds (= 13) INTERVAL_60_S Output this message every 60 seconds (= 14) DEFAULT Restore this message's rate back to its default value (= 255)
Definition at line 2105 of file configuration.h.
NmeaMessageType
| strong |
Integer ID for NMEA messages.
- Enumeration values
Definition at line 2007 of file configuration.h.
ProtocolType
| strong |
The framing protocol of a message.
- Enumeration values
-
INVALID (= 0) FUSION_ENGINE (= 1) NMEA (= 2) RTCM (= 3) ALL This is used for requesting the configuration for all protocols (= 0xFF)
Definition at line 1679 of file configuration.h.
SocketType
| strong |
The socket type specifying how data is transmitted for UNIX domain sockets.
- Enumeration values
Definition at line 1892 of file configuration.h.
TransportDirection
| strong |
The direction (client/server) for an individual interface.
- Enumeration values
-
INVALID (= 0) SERVER A server listening for one or more incoming remote connections (= 1) CLIENT A client connecting to a specified remote server (= 2)
Definition at line 1848 of file configuration.h.
TransportType
| strong |
Type of I/O interface transport.
- Enumeration values
-
INVALID (= 0) SERIAL A serial data interface (e.g (= 1) FILE A interface that writes to a file (= 2) TCP A TCP client or server (= 4) UDP A UDP client or server (= 5) WEBSOCKET A WebSocket client or server (= 7) UNIX A UNIX domain socket client or server (= 8) CURRENT Set/get the configuration for the interface on which the command was received (= 254) ALL Set/get the configuration for the all I/O interfaces (= 255)
Definition at line 1730 of file configuration.h.
Operators
operator<<()
| inline |
InterfaceID stream operator.
Definition at line 1998 of file configuration.h.
operator<<()
| inline |
InterfaceConfigType stream operator.
Definition at line 1670 of file configuration.h.
operator<<()
| inline |
MessageRate stream operator.
Definition at line 2239 of file configuration.h.
operator<<()
| inline |
NmeaMessageType stream operator.
Definition at line 2096 of file configuration.h.
operator<<()
| inline |
ProtocolType stream operator.
Definition at line 1721 of file configuration.h.
operator<<()
| inline |
SocketType stream operator.
Definition at line 1938 of file configuration.h.
operator<<()
| inline |
TransportDirection stream operator.
Definition at line 1882 of file configuration.h.
operator<<()
| inline |
TransportType stream operator.
Definition at line 1839 of file configuration.h.
Functions
to_string()
|
Get a human-friendly string name for the specified ConfigType.
- Parameters
-
type The desired configuration parameter type.
- Returns
The corresponding string name.
Definition at line 1633 of file configuration.h.
to_string()
|
Get a human-friendly string name for the specified MessageRate.
- Parameters
-
value The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 2196 of file configuration.h.
to_string()
|
Get a human-friendly string name for the specified NmeaMessageType.
- Parameters
-
value The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 2053 of file configuration.h.
to_string()
|
Get a human-friendly string name for the specified ProtocolType.
- Parameters
-
val The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 1700 of file configuration.h.
to_string()
|
Get a human-friendly string name for the specified SocketType.
- Parameters
-
val The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 1919 of file configuration.h.
to_string()
|
Get a human-friendly string name for the specified TransportDirection.
- Parameters
-
val The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 1865 of file configuration.h.
to_string()
|
Get a human-friendly string name for the specified TransportType.
- Parameters
-
val The enum to get the string name for.
- Returns
The corresponding string name.
Definition at line 1810 of file configuration.h.
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.