Skip to main content

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

structGetMessageRate

Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1.0). More...

structInterfaceConfigSubmessage

I/O interface parameter configuration submessage (used when sending a SetConfigMessage or GetConfigMessage for ConfigType::INTERFACE_CONFIG). More...

structInterfaceID

Identifier for an I/O interface. More...

structMessageRateResponse

Response to a GetMessageRate request (MessageType::MESSAGE_RATE_RESPONSE, version 1.1). More...

structMessageRateResponseEntry

An element of a MessageRateResponse message. More...

structSetMessageRate

Set the output rate for the requested message types (MessageType::SET_MESSAGE_RATE, version 1.0). More...

structSupportedIOInterfacesMessage

A list of transport interfaces supported by the device (MessageType::SUPPORTED_IO_INTERFACES, version 1.0). More...

Enumerations Index

enum classInterfaceConfigType : uint8_t { ... }

An identifier for the contents of a output interface configuration submessage. More...

enum classMessageRate : uint8_t { ... }

The output rate for a message type on an interface. More...

enum classNmeaMessageType : uint16_t { ... }

Integer ID for NMEA messages. More...

enum classProtocolType : uint8_t { ... }

The framing protocol of a message. More...

enum classSocketType : uint8_t { ... }

The socket type specifying how data is transmitted for UNIX domain sockets. More...

enum classTransportDirection : uint8_t { ... }

The direction (client/server) for an individual interface. More...

enum classTransportType : 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

enum class point_one::fusion_engine::messages::InterfaceConfigType : uint8_t
strong

An identifier for the contents of a output interface configuration submessage.

Enumeration values
INVALID (= 0)
OUTPUT_DIAGNOSTICS_MESSAGESEnable/disable output of diagnostic data on this interface (= 1)
BAUD_RATEConfigure the serial baud rate (in bits/second) (= 2)
REMOTE_ADDRESSConfigure the remote network IP address or hostname for a client to connect to (= 3)
PORTConfigure the network port (= 4)
ENABLEDEnable/disable the interface (= 5)
DIRECTIONSet the interface direction (client/server) (= 6)
SOCKET_TYPESet the UNIX domain socket type (streaming/datagram/sequenced) (= 7)
FILE_PATHConfigure the path to a local file or UNIX domain socket (= 8)

See also InterfaceConfigSubmessage.

Definition at line 1534 of file configuration.h.

1535 INVALID = 0,
1536
1537 /**
1538 * Enable/disable output of diagnostic data on this interface.
1539 *
1540 * Valid for:
1541 * - All @ref TransportType
1542 *
1543 * @note
1544 * Enabling this setting will override the message rate/off settings for some
1545 * FusionEngine messages.
1546 *
1547 * Payload format: `bool`
1548 */
1550
1551 /**
1552 * Configure the serial baud rate (in bits/second).
1553 *
1554 * Valid for:
1555 * - @ref TransportType::SERIAL
1556 *
1557 * Payload format: `uint32_t`
1558 */
1559 BAUD_RATE = 2,
1560
1561 /**
1562 * Configure the remote network IP address or hostname for a client to connect
1563 * to.
1564 *
1565 * Valid for:
1566 * - @ref TransportType::TCP
1567 * - @ref TransportType::UDP
1568 *
1569 * Payload format: `char[64]` containing a NULL terminated string.
1570 */
1571 REMOTE_ADDRESS = 3,
1572
1573 /**
1574 * Configure the network port.
1575 *
1576 * Valid for:
1577 * - @ref TransportType::TCP
1578 * - @ref TransportType::UDP
1579 * - @ref TransportType::WEBSOCKET
1580 *
1581 * Payload format: `uint16_t`
1582 */
1583 PORT = 4,
1584
1585 /**
1586 * Enable/disable the interface.
1587 *
1588 * Valid for all @ref TransportType values.
1589 *
1590 * Payload format: `bool`
1591 */
1592 ENABLED = 5,
1593
1594 /**
1595 * Set the interface direction (client/server).
1596 *
1597 * Valid for:
1598 * - @ref TransportType::TCP
1599 * - @ref TransportType::WEBSOCKET
1600 * - @ref TransportType::UNIX
1601 *
1602 * Payload format: @ref TransportDirection
1603 */
1604 DIRECTION = 6,
1605
1606 /**
1607 * Set the UNIX domain socket type (streaming/datagram/sequenced).
1608 *
1609 * Valid for:
1610 * - @ref TransportType::UNIX
1611 *
1612 * Payload format: @ref SocketType
1613 */
1614 SOCKET_TYPE = 7,
1615
1616 /**
1617 * Configure the path to a local file or UNIX domain socket.
1618 *
1619 * Valid for:
1620 * - @ref TransportType::FILE
1621 * - @ref TransportType::UNIX
1622 *
1623 * Payload format: `char[64]` containing a NULL terminated string.
1624 */
1625 FILE_PATH = 8,
1626};

MessageRate

enum class point_one::fusion_engine::messages::MessageRate : uint8_t
strong

The output rate for a message type on an interface.

Enumeration values
OFFDisable output of this message (= 0)
ON_CHANGEOutput this message each time a new value is available (= 1)
MAX_RATEAlias for MessageRate::ON_CHANGE (= 1)
INTERVAL_10_MSOutput this message every 10 milliseconds (= 2)
INTERVAL_20_MSOutput this message every 20 milliseconds (= 3)
INTERVAL_40_MSOutput this message every 40 milliseconds (= 4)
INTERVAL_50_MSOutput this message every 50 milliseconds (= 5)
INTERVAL_100_MSOutput this message every 100 milliseconds (= 6)
INTERVAL_200_MSOutput this message every 200 milliseconds (= 7)
INTERVAL_500_MSOutput this message every 500 milliseconds (= 8)
INTERVAL_1_SOutput this message every second (= 9)
INTERVAL_2_SOutput this message every 2 seconds (= 10)
INTERVAL_5_SOutput this message every 5 seconds (= 11)
INTERVAL_10_SOutput this message every 10 seconds (= 12)
INTERVAL_30_SOutput this message every 30 seconds (= 13)
INTERVAL_60_SOutput this message every 60 seconds (= 14)
DEFAULTRestore this message's rate back to its default value (= 255)

Definition at line 2108 of file configuration.h.

2108enum class MessageRate : uint8_t {
2109 /**
2110 * Disable output of this message.
2111 */
2112 OFF = 0,
2113 /**
2114 * Output this message each time a new value is available.
2115 */
2116 ON_CHANGE = 1,
2117 /** Alias for @ref MessageRate::ON_CHANGE. */
2118 MAX_RATE = 1,
2119 /**
2120 * Output this message every 10 milliseconds. Not supported for all messages
2121 * or platforms.
2122 */
2123 INTERVAL_10_MS = 2,
2124 /**
2125 * Output this message every 20 milliseconds. Not supported for all messages
2126 * or platforms.
2127 */
2128 INTERVAL_20_MS = 3,
2129 /**
2130 * Output this message every 40 milliseconds. Not supported for all messages
2131 * or platforms.
2132 */
2133 INTERVAL_40_MS = 4,
2134 /**
2135 * Output this message every 50 milliseconds. Not supported for all messages
2136 * or platforms.
2137 */
2138 INTERVAL_50_MS = 5,
2139 /**
2140 * Output this message every 100 milliseconds. Not supported for all messages
2141 * or platforms.
2142 */
2143 INTERVAL_100_MS = 6,
2144 /**
2145 * Output this message every 200 milliseconds. Not supported for all messages
2146 * or platforms.
2147 */
2148 INTERVAL_200_MS = 7,
2149 /**
2150 * Output this message every 500 milliseconds. Not supported for all messages
2151 * or platforms.
2152 */
2153 INTERVAL_500_MS = 8,
2154 /**
2155 * Output this message every second. Not supported for all messages or
2156 * platforms.
2157 */
2158 INTERVAL_1_S = 9,
2159 /**
2160 * Output this message every 2 seconds. Not supported for all messages or
2161 * platforms.
2162 */
2163 INTERVAL_2_S = 10,
2164 /**
2165 * Output this message every 5 seconds. Not supported for all messages or
2166 * platforms.
2167 */
2168 INTERVAL_5_S = 11,
2169 /**
2170 * Output this message every 10 seconds. Not supported for all messages or
2171 * platforms.
2172 */
2173 INTERVAL_10_S = 12,
2174 /**
2175 * Output this message every 30 seconds. Not supported for all messages or
2176 * platforms.
2177 */
2178 INTERVAL_30_S = 13,
2179 /**
2180 * Output this message every 60 seconds. Not supported for all messages or
2181 * platforms.
2182 */
2183 INTERVAL_60_S = 14,
2184 /**
2185 * Restore this message's rate back to its default value.
2186 */
2187 DEFAULT = 255
2188};

NmeaMessageType

enum class point_one::fusion_engine::messages::NmeaMessageType : uint16_t
strong

Integer ID for NMEA messages.

Enumeration values
INVALID (= 0)
Standard NMEA Messages
GGA (= 1)
GLL (= 2)
GSA (= 3)
GSV (= 4)
RMC (= 5)
VTG (= 6)
ZDA (= 7)
Point One Proprietary Messages
P1CALSTATUS (= 1000)
P1MSG (= 1001)
Quectel Proprietary Messages
PQTMVERNO (= 1200)
PQTMVER (= 1201)
PQTMGNSS (= 1202)
PQTMVERNO_SUB (= 1203)
PQTMVER_SUB (= 1204)
PQTMTXT (= 1205)

Definition at line 2010 of file configuration.h.

2011 INVALID = 0,
2012
2013 /**
2014 * @name Standard NMEA Messages
2015 * @{
2016 */
2017 GGA = 1,
2018 GLL = 2,
2019 GSA = 3,
2020 GSV = 4,
2021 RMC = 5,
2022 VTG = 6,
2023 ZDA = 7,
2024 /** @} */
2025
2026 /**
2027 * @name Point One Proprietary Messages
2028 * @{
2029 */
2030 P1CALSTATUS = 1000,
2031 P1MSG = 1001,
2032 /** @} */
2033
2034 /**
2035 * @name Quectel Proprietary Messages
2036 * @{
2037 */
2038 PQTMVERNO = 1200,
2039 PQTMVER = 1201,
2040 PQTMGNSS = 1202,
2041 PQTMVERNO_SUB = 1203,
2042 PQTMVER_SUB = 1204,
2043 PQTMTXT = 1205,
2044 /** @} */
2045};

ProtocolType

enum class point_one::fusion_engine::messages::ProtocolType : uint8_t
strong

The framing protocol of a message.

Enumeration values
INVALID (= 0)
FUSION_ENGINE (= 1)
NMEA (= 2)
RTCM (= 3)
ALLThis is used for requesting the configuration for all protocols (= 0xFF)

Definition at line 1682 of file configuration.h.

1682enum class ProtocolType : uint8_t {
1683 INVALID = 0,
1684 FUSION_ENGINE = 1,
1685 NMEA = 2,
1686 RTCM = 3,
1687 /** This is used for requesting the configuration for all protocols. */
1688 ALL = 0xFF,
1689};

SocketType

enum class point_one::fusion_engine::messages::SocketType : uint8_t
strong

The socket type specifying how data is transmitted for UNIX domain sockets.

Enumeration values
INVALID (= 0)
STREAMOperate in connection-oriented streaming mode and do not preserve message boundaries (similar to TCP) (= 1)
DATAGRAMOperate in datagram mode, preserving message boundaries but not maintaining client connections (similar to UDP) (= 2)
SEQPACKETOperate in sequenced packet mode, which is both connection-oriented and preserves message boundaries (= 3)

Definition at line 1895 of file configuration.h.

1895enum class SocketType : uint8_t {
1896 INVALID = 0,
1897 /**
1898 * Operate in connection-oriented streaming mode and do not preserve message
1899 * boundaries (similar to TCP).
1900 */
1901 STREAM = 1,
1902 /**
1903 * Operate in datagram mode, preserving message boundaries but not maintaining
1904 * client connections (similar to UDP).
1905 */
1906 DATAGRAM = 2,
1907 /**
1908 * Operate in sequenced packet mode, which is both connection-oriented and
1909 * preserves message boundaries.
1910 */
1911 SEQPACKET = 3,
1912};

TransportDirection

enum class point_one::fusion_engine::messages::TransportDirection : uint8_t
strong

The direction (client/server) for an individual interface.

Enumeration values
INVALID (= 0)
SERVERA server listening for one or more incoming remote connections (= 1)
CLIENTA client connecting to a specified remote server (= 2)

Definition at line 1851 of file configuration.h.

1852 INVALID = 0,
1853 /** A server listening for one or more incoming remote connections. */
1854 SERVER = 1,
1855 /** A client connecting to a specified remote server. */
1856 CLIENT = 2,
1857};

TransportType

enum class point_one::fusion_engine::messages::TransportType : uint8_t
strong

Type of I/O interface transport.

Enumeration values
INVALID (= 0)
SERIALA serial data interface (e.g (= 1)
FILEA interface that writes to a file (= 2)
TCPA TCP client or server (= 4)
UDPA UDP client or server (= 5)
WEBSOCKETA WebSocket client or server (= 7)
UNIXA UNIX domain socket client or server (= 8)
CURRENTSet/get the configuration for the interface on which the command was received (= 254)
ALLSet/get the configuration for the all I/O interfaces (= 255)

Definition at line 1733 of file configuration.h.

1733enum class TransportType : uint8_t {
1734 INVALID = 0,
1735 /** A serial data interface (e.g. an RS232 connection). */
1736 SERIAL = 1,
1737 /** A interface that writes to a file. */
1738 FILE = 2,
1739 // RESERVED = 3,
1740 /**
1741 * A TCP client or server.
1742 *
1743 * A TCP client will connect to a specified TCP server address and port. A TCP
1744 * server will listen for incoming client connections, and may communicate
1745 * with multiple clients at a time. Responses to commands will be sent only to
1746 * the the issuing client. All other configured output messages will be sent
1747 * to all clients.
1748 *
1749 * See also @ref TransportDirection.
1750 */
1751 TCP = 4,
1752 /**
1753 * A UDP client or server.
1754 *
1755 * UDP connections are stateless, unlike TCP. A UDP interface will listen for
1756 * incoming messages on a specified port. It may optionally be configured to
1757 * sent output to a specific hostname or IP address, including broadcast or
1758 * multicast addresses. If an address is not specified, the interface will not
1759 * send any output automatically, but it will respond to incoming commands,
1760 * sending responses back to the remote client's address and port.
1761 */
1762 UDP = 5,
1763 // RESERVED = 6,
1764 /**
1765 * A WebSocket client or server.
1766 *
1767 * WebSocket connections are similar to TCP connections, and use TCP as their
1768 * underlying transport, but use the WebSocket protocol to send and receive
1769 * data.
1770 *
1771 * See also @ref TransportDirection.
1772 */
1773 WEBSOCKET = 7,
1774 /**
1775 * A UNIX domain socket client or server.
1776 *
1777 * UNIX domain socket connections may be configured as either client that
1778 * connects to an existing server, or a server that listens for one or more
1779 * incoming client connections. UNIX domain sockets may operate in one of
1780 * three possible modes:
1781 * - A connection-oriented streaming mode where packet boundaries are not
1782 * preserved (similar to TCP)
1783 * - Datagram mode where packet boundaries are preserved but connections
1784 * between the client and server are not maintained, and the interface sends
1785 * output to an optional configured file (similar to UDP)
1786 * - Sequenced packet mode, which is connection-oriented (like TCP) but also
1787 * preserves message boundaries (like UDP) and guarantees in-order delivery
1788 *
1789 * For a UNIX domain socket, you must specify:
1790 * - The @ref TransportDirection (client or server)
1791 * - The @ref SocketType (streaming, datagram, or sequenced)
1792 * - The path to a socket file to connect to (client) or create (server)
1793 */
1794 UNIX = 8,
1795 /**
1796 * Set/get the configuration for the interface on which the command was
1797 * received.
1798 */
1799 CURRENT = 254,
1800 /** Set/get the configuration for the all I/O interfaces. */
1801 ALL = 255,
1802};

Operators

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, const InterfaceID & val)
inline

InterfaceID stream operator.

Definition at line 2001 of file configuration.h.

2002 stream << "[type=" << val.type << ", index=" << (int)val.index << "]";
2003 return stream;
2004}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, InterfaceConfigType type)
inline

InterfaceConfigType stream operator.

Definition at line 1673 of file configuration.h.

1674 stream << to_string(type) << " (" << (int)type << ")";
1675 return stream;
1676}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, MessageRate val)
inline

MessageRate stream operator.

Definition at line 2242 of file configuration.h.

2243 stream << to_string(val) << " (" << (int)val << ")";
2244 return stream;
2245}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, NmeaMessageType val)
inline

NmeaMessageType stream operator.

Definition at line 2099 of file configuration.h.

2100 stream << to_string(val) << " (" << (int)val << ")";
2101 return stream;
2102}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, ProtocolType val)
inline

ProtocolType stream operator.

Definition at line 1724 of file configuration.h.

1725 stream << to_string(val) << " (" << (int)val << ")";
1726 return stream;
1727}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, SocketType val)
inline

SocketType stream operator.

Definition at line 1941 of file configuration.h.

1942 stream << to_string(val) << " (" << (int)val << ")";
1943 return stream;
1944}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, TransportDirection val)
inline

TransportDirection stream operator.

Definition at line 1885 of file configuration.h.

1886 stream << to_string(val) << " (" << (int)val << ")";
1887 return stream;
1888}

operator<<()

p1_ostream & point_one::fusion_engine::messages::operator<< (p1_ostream & stream, TransportType val)
inline

TransportType stream operator.

Definition at line 1842 of file configuration.h.

1843 stream << to_string(val) << " (" << (int)val << ")";
1844 return stream;
1845}

Functions

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (InterfaceConfigType type)

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 1636 of file configuration.h.

1637 switch (type) {
1639 return "Invalid";
1640
1642 return "Diagnostic Messages Enabled";
1643
1645 return "Serial Baud Rate";
1646
1648 return "Remote Network Address";
1649
1651 return "Network Port";
1652
1654 return "Interface Enabled";
1655
1657 return "Transport Direction";
1658
1660 return "Socket Type";
1661
1663 return "File Path";
1664 }
1665
1666 return "Unrecognized Configuration";
1667}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (MessageRate value)

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 2199 of file configuration.h.

2200 switch (value) {
2201 case MessageRate::OFF:
2202 return "OFF";
2204 return "ON_CHANGE";
2206 return "INTERVAL_10_MS";
2208 return "INTERVAL_20_MS";
2210 return "INTERVAL_40_MS";
2212 return "INTERVAL_50_MS";
2214 return "INTERVAL_100_MS";
2216 return "INTERVAL_200_MS";
2218 return "INTERVAL_500_MS";
2220 return "INTERVAL_1_S";
2222 return "INTERVAL_2_S";
2224 return "INTERVAL_5_S";
2226 return "INTERVAL_10_S";
2228 return "INTERVAL_30_S";
2230 return "INTERVAL_60_S";
2232 return "DEFAULT";
2233 }
2234
2235 return "Unrecognized";
2236}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (NmeaMessageType value)

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 2056 of file configuration.h.

2057 switch (value) {
2059 return "INVALID";
2061 return "GGA";
2063 return "GLL";
2065 return "GSA";
2067 return "GSV";
2069 return "RMC";
2071 return "VTG";
2073 return "ZDA";
2075 return "P1CALSTATUS";
2077 return "P1MSG";
2079 return "PQTMVERNO";
2081 return "PQTMVER";
2083 return "PQTMGNSS";
2085 return "PQTMVERNO_SUB";
2087 return "PQTMVER_SUB";
2089 return "PQTMTXT";
2090 }
2091
2092 return "Unrecognized";
2093}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (ProtocolType val)

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 1703 of file configuration.h.

1704 switch (val) {
1706 return "Invalid";
1708 return "FusionEngine";
1710 return "NMEA";
1712 return "RTCM";
1714 return "ALL";
1715 }
1716
1717 return "Unrecognized";
1718}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SocketType val)

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 1922 of file configuration.h.

1923 switch (val) {
1925 return "INVALID";
1927 return "STREAM";
1929 return "DATAGRAM";
1931 return "SEQPACKET";
1932 }
1933
1934 return "Unrecognized";
1935}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TransportDirection val)

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 1868 of file configuration.h.

1869 switch (val) {
1871 return "INVALID";
1873 return "SERVER";
1875 return "CLIENT";
1876 }
1877
1878 return "Unrecognized";
1879}

to_string()

P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TransportType val)

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 1813 of file configuration.h.

1814 switch (val) {
1816 return "Invalid";
1818 return "Serial";
1820 return "File";
1822 return "TCP";
1824 return "UDP";
1826 return "WebSocket";
1828 return "UNIX";
1830 return "Current";
1832 return "All";
1833 }
1834
1835 return "Unrecognized";
1836}

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.