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). 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). More...

structSupportedIOInterfacesMessage

A list of transport interfaces supported by the device (MessageType::SUPPORTED_IO_INTERFACES, version 1). 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 1531 of file configuration.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

Operators

operator<<()

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

InterfaceID stream operator.

Definition at line 1998 of file configuration.h.

1999 stream << "[type=" << val.type << ", index=" << (int)val.index << "]";
2000 return stream;
2001}

operator<<()

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

InterfaceConfigType stream operator.

Definition at line 1670 of file configuration.h.

1671 stream << to_string(type) << " (" << (int)type << ")";
1672 return stream;
1673}

operator<<()

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

MessageRate stream operator.

Definition at line 2239 of file configuration.h.

2240 stream << to_string(val) << " (" << (int)val << ")";
2241 return stream;
2242}

operator<<()

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

NmeaMessageType stream operator.

Definition at line 2096 of file configuration.h.

2097 stream << to_string(val) << " (" << (int)val << ")";
2098 return stream;
2099}

operator<<()

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

ProtocolType stream operator.

Definition at line 1721 of file configuration.h.

1722 stream << to_string(val) << " (" << (int)val << ")";
1723 return stream;
1724}

operator<<()

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

SocketType stream operator.

Definition at line 1938 of file configuration.h.

1939 stream << to_string(val) << " (" << (int)val << ")";
1940 return stream;
1941}

operator<<()

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

TransportDirection stream operator.

Definition at line 1882 of file configuration.h.

1883 stream << to_string(val) << " (" << (int)val << ")";
1884 return stream;
1885}

operator<<()

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

TransportType stream operator.

Definition at line 1839 of file configuration.h.

1840 stream << to_string(val) << " (" << (int)val << ")";
1841 return stream;
1842}

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

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

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

2197 switch (value) {
2198 case MessageRate::OFF:
2199 return "OFF";
2201 return "ON_CHANGE";
2203 return "INTERVAL_10_MS";
2205 return "INTERVAL_20_MS";
2207 return "INTERVAL_40_MS";
2209 return "INTERVAL_50_MS";
2211 return "INTERVAL_100_MS";
2213 return "INTERVAL_200_MS";
2215 return "INTERVAL_500_MS";
2217 return "INTERVAL_1_S";
2219 return "INTERVAL_2_S";
2221 return "INTERVAL_5_S";
2223 return "INTERVAL_10_S";
2225 return "INTERVAL_30_S";
2227 return "INTERVAL_60_S";
2229 return "DEFAULT";
2230 }
2231
2232 return "Unrecognized";
2233}

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

2054 switch (value) {
2056 return "INVALID";
2058 return "GGA";
2060 return "GLL";
2062 return "GSA";
2064 return "GSV";
2066 return "RMC";
2068 return "VTG";
2070 return "ZDA";
2072 return "P1CALSTATUS";
2074 return "P1MSG";
2076 return "PQTMVERNO";
2078 return "PQTMVER";
2080 return "PQTMGNSS";
2082 return "PQTMVERNO_SUB";
2084 return "PQTMVER_SUB";
2086 return "PQTMTXT";
2087 }
2088
2089 return "Unrecognized";
2090}

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

1701 switch (val) {
1703 return "Invalid";
1705 return "FusionEngine";
1707 return "NMEA";
1709 return "RTCM";
1711 return "ALL";
1712 }
1713
1714 return "Unrecognized";
1715}

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

1920 switch (val) {
1922 return "INVALID";
1924 return "STREAM";
1926 return "DATAGRAM";
1928 return "SEQPACKET";
1929 }
1930
1931 return "Unrecognized";
1932}

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

1866 switch (val) {
1868 return "INVALID";
1870 return "SERVER";
1872 return "CLIENT";
1873 }
1874
1875 return "Unrecognized";
1876}

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

1811 switch (val) {
1813 return "Invalid";
1815 return "Serial";
1817 return "File";
1819 return "TCP";
1821 return "UDP";
1823 return "WebSocket";
1825 return "UNIX";
1827 return "Current";
1829 return "All";
1830 }
1831
1832 return "Unrecognized";
1833}

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.