This structure shows what parameters are configurable in the TcpClientConfig CDI group definition. More...

#include <ConfiguredTcpConnection.hxx>

Static Public Attributes
static constexpr const char *	SEARCH_MODE_NAME = "Search Mode"
	Visible name of the search_mode field.

static constexpr const char *	SEARCH_MODE_DESCR
	Visible description of the search_mode field.

static constexpr const char *	SEARCH_MODE_MAP
	<map> of possible keys and descriptive values to show to the user for the search_mode field.

static constexpr const char *	MANUAL_ADDRESS_NAME = "Manual Address"
	Visible name of the manual address group.

static constexpr const char *	MANUAL_ADDRESS_DESCR
	Visible description of the manual address group.

static constexpr const char *	IP_ADDRESS_NAME = "IP Address"
	Visible name of the ip address field inside the manual address group.

static constexpr const char *	IP_ADDRESS_DESCR
	Visible description of the ip address field inside the manual address group.

static constexpr int	DEFAULT_PORT = 12021
	Default value for the port number field.

static constexpr const char *	PORT_NAME = "Port Number"
	Visible name of the port number field.

static constexpr const char *	PORT_DESCR
	Visible description of the port number field.

static constexpr const char *	AUTO_ADDRESS_NAME = "Auto Address"
	Visible name of the auto address group.

static constexpr const char *	AUTO_ADDRESS_DESCR
	Visible description of the auto address group.

static constexpr const char *	SERVICE_NAME = "mDNS Service"
	Visible name of the service name field in the auto address group.

static constexpr const char *	SERVICE_DESCR
	Visible description of the service name field in the auto address group.

static constexpr const char *	HOST_NAME = "Only Hostname"
	Visible name of the host name field in the auto address group.

static constexpr const char *	HOST_DESCR
	Visible description of the host name field in the auto address group.

static constexpr const char *	RECONNECT_NAME = "Reconnect"
	Visible name of the reconnect enable field.

static constexpr const char *	RECONNECT_DESCR
	Visible description of the reconnect enable field.

static constexpr const char *	RECONNECT_MAP
	<map> of possible keys and descriptive values to show to the user for the reconnect field.

static constexpr int	RECONNECT_DEFAULT = 1
	Default value for the Reconnect parameter.

Detailed Description

This structure shows what parameters are configurable in the TcpClientConfig CDI group definition.

The parameters here will be used in the CDI rendering of the group; many of them are part of the UI presented by the XML and thus subject to localization possibilities.

Definition at line 47 of file ConfiguredTcpConnection.hxx.

Member Data Documentation

◆ AUTO_ADDRESS_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::AUTO_ADDRESS_DESCR

staticconstexpr

Initial value:

=

"Advanced settings for the server IP address auto-detection (mDNS)."

Visible description of the auto address group.

Definition at line 91 of file ConfiguredTcpConnection.hxx.

◆ AUTO_ADDRESS_NAME

constexpr const char* openlcb::TcpClientDefaultParams::AUTO_ADDRESS_NAME = "Auto Address"

staticconstexpr

Visible name of the auto address group.

Definition at line 89 of file ConfiguredTcpConnection.hxx.

◆ DEFAULT_PORT

constexpr int openlcb::TcpClientDefaultParams::DEFAULT_PORT = 12021

staticconstexpr

Default value for the port number field.

This will also be used for factory reset code, not just for user documentation.

Definition at line 80 of file ConfiguredTcpConnection.hxx.

◆ HOST_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::HOST_DESCR

staticconstexpr

Initial value:

=
        "Use when multiple servers provide the same service on the network. If "
        "set, selects this specific host name; the connection will fail if "
        "none of the servers have this hostname (use correct capitalization!). "
        "Example: My JMRI Railroad"

Visible description of the host name field in the auto address group.

Definition at line 104 of file ConfiguredTcpConnection.hxx.

◆ HOST_NAME

constexpr const char* openlcb::TcpClientDefaultParams::HOST_NAME = "Only Hostname"

staticconstexpr

Visible name of the host name field in the auto address group.

Definition at line 102 of file ConfiguredTcpConnection.hxx.

◆ IP_ADDRESS_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::IP_ADDRESS_DESCR

staticconstexpr

Initial value:

=

"Enter the server IP address. Example: 192.168.0.55"

Visible description of the ip address field inside the manual address group.

Definition at line 75 of file ConfiguredTcpConnection.hxx.

◆ IP_ADDRESS_NAME

constexpr const char* openlcb::TcpClientDefaultParams::IP_ADDRESS_NAME = "IP Address"

staticconstexpr

Visible name of the ip address field inside the manual address group.

Definition at line 72 of file ConfiguredTcpConnection.hxx.

◆ MANUAL_ADDRESS_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::MANUAL_ADDRESS_DESCR

staticconstexpr

Initial value:

=

"Set IP address here if auto-detection does not work."

Visible description of the manual address group.

Definition at line 68 of file ConfiguredTcpConnection.hxx.

◆ MANUAL_ADDRESS_NAME

constexpr const char* openlcb::TcpClientDefaultParams::MANUAL_ADDRESS_NAME = "Manual Address"

staticconstexpr

Visible name of the manual address group.

Definition at line 66 of file ConfiguredTcpConnection.hxx.

◆ PORT_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::PORT_DESCR

staticconstexpr

Initial value:

=
        "TCP port number of the server. Most of the time this does not need to "
        "be changed."

Visible description of the port number field.

Definition at line 84 of file ConfiguredTcpConnection.hxx.

◆ PORT_NAME

constexpr const char* openlcb::TcpClientDefaultParams::PORT_NAME = "Port Number"

staticconstexpr

Visible name of the port number field.

Definition at line 82 of file ConfiguredTcpConnection.hxx.

◆ RECONNECT_DEFAULT

constexpr int openlcb::TcpClientDefaultParams::RECONNECT_DEFAULT = 1

staticconstexpr

Default value for the Reconnect parameter.

Definition at line 122 of file ConfiguredTcpConnection.hxx.

◆ RECONNECT_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::RECONNECT_DESCR

staticconstexpr

Initial value:

=
        "If enabled, tries the last known good IP address before searching for "
        "the server."

Visible description of the reconnect enable field.

Definition at line 113 of file ConfiguredTcpConnection.hxx.

◆ RECONNECT_MAP

constexpr const char* openlcb::TcpClientDefaultParams::RECONNECT_MAP

staticconstexpr

Initial value:

=
        "<relation><property>0</property><value>Disabled</value></relation>"
        "<relation><property>1</property><value>Enabled</value></relation>"

<map> of possible keys and descriptive values to show to the user for the reconnect field.

Definition at line 118 of file ConfiguredTcpConnection.hxx.

◆ RECONNECT_NAME

constexpr const char* openlcb::TcpClientDefaultParams::RECONNECT_NAME = "Reconnect"

staticconstexpr

Visible name of the reconnect enable field.

Definition at line 111 of file ConfiguredTcpConnection.hxx.

◆ SEARCH_MODE_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::SEARCH_MODE_DESCR

staticconstexpr

Initial value:

=
        "Defines the order of how to locate the server to connect to. 'auto' "
        "uses the mDNS protocol to find the IP address automatically. 'manual' "
        "uses the IP address entered in this settings."

Visible description of the search_mode field.

Definition at line 53 of file ConfiguredTcpConnection.hxx.

◆ SEARCH_MODE_MAP

constexpr const char* openlcb::TcpClientDefaultParams::SEARCH_MODE_MAP

staticconstexpr

Initial value:

=
        "<relation><property>0</property><value>Auto, Manual</value></relation>"
        "<relation><property>1</property><value>Manual, Auto</value></relation>"
        "<relation><property>2</property><value>Auto Only</value></relation>"
        "<relation><property>3</property><value>Manual Only</value></relation>"

<map> of possible keys and descriptive values to show to the user for the search_mode field.

Definition at line 59 of file ConfiguredTcpConnection.hxx.

◆ SEARCH_MODE_NAME

constexpr const char* openlcb::TcpClientDefaultParams::SEARCH_MODE_NAME = "Search Mode"

staticconstexpr

Visible name of the search_mode field.

Definition at line 51 of file ConfiguredTcpConnection.hxx.

◆ SERVICE_DESCR

constexpr const char* openlcb::TcpClientDefaultParams::SERVICE_DESCR

staticconstexpr

Initial value:

=

"mDNS or Bonjour service name, such as _openlcb-can._tcp"

Visible description of the service name field in the auto address group.

Definition at line 98 of file ConfiguredTcpConnection.hxx.

◆ SERVICE_NAME

constexpr const char* openlcb::TcpClientDefaultParams::SERVICE_NAME = "mDNS Service"

staticconstexpr

Visible name of the service name field in the auto address group.

Definition at line 95 of file ConfiguredTcpConnection.hxx.

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

ConfiguredTcpConnection.hxx

Static Public Attributes

Detailed Description

Member Data Documentation

◆ AUTO_ADDRESS_DESCR

◆ AUTO_ADDRESS_NAME

◆ DEFAULT_PORT

◆ HOST_DESCR

◆ HOST_NAME

◆ IP_ADDRESS_DESCR

◆ IP_ADDRESS_NAME

◆ MANUAL_ADDRESS_DESCR

◆ MANUAL_ADDRESS_NAME

◆ PORT_DESCR

◆ PORT_NAME

◆ RECONNECT_DEFAULT

◆ RECONNECT_DESCR

◆ RECONNECT_MAP

◆ RECONNECT_NAME

◆ SEARCH_MODE_DESCR

◆ SEARCH_MODE_MAP

◆ SEARCH_MODE_NAME

◆ SERVICE_DESCR

◆ SERVICE_NAME