ConfiguredTcpConnection.hxx

Go to the documentation of this file.

 
#ifndef _OPENLCB_CONFIGUREDTCPCONNCTION_HXX_
#define _OPENLCB_CONFIGUREDTCPCONNCTION_HXX_
 
#include "openlcb/ConfigRepresentation.hxx"
 
namespace openlcb
{
 
class TcpClientDefaultParams
{
public:
    static constexpr const char *SEARCH_MODE_NAME = "Search Mode";
    static constexpr const char *SEARCH_MODE_DESCR =
        "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.";
    static constexpr const char *SEARCH_MODE_MAP =
        "<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>";
 
    static constexpr const char *MANUAL_ADDRESS_NAME = "Manual Address";
    static constexpr const char *MANUAL_ADDRESS_DESCR =
        "Set IP address here if auto-detection does not work.";
 
    static constexpr const char *IP_ADDRESS_NAME = "IP Address";
    static constexpr const char *IP_ADDRESS_DESCR =
        "Enter the server IP address. Example: 192.168.0.55";
 
    static constexpr int DEFAULT_PORT = 12021;
    static constexpr const char *PORT_NAME = "Port Number";
    static constexpr const char *PORT_DESCR =
        "TCP port number of the server. Most of the time this does not need to "
        "be changed.";
 
    static constexpr const char *AUTO_ADDRESS_NAME = "Auto Address";
    static constexpr const char *AUTO_ADDRESS_DESCR =
        "Advanced settings for the server IP address auto-detection (mDNS).";
 
    static constexpr const char *SERVICE_NAME = "mDNS Service";
    static constexpr const char *SERVICE_DESCR =
        "mDNS or Bonjour service name, such as _openlcb-can._tcp";
 
    static constexpr const char *HOST_NAME = "Only Hostname";
    static constexpr const char *HOST_DESCR =
        "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";
 
    static constexpr const char *RECONNECT_NAME = "Reconnect";
    static constexpr const char *RECONNECT_DESCR =
        "If enabled, tries the last known good IP address before searching for "
        "the server.";
    static constexpr const char *RECONNECT_MAP =
        "<relation><property>0</property><value>Disabled</value></relation>"
        "<relation><property>1</property><value>Enabled</value></relation>";
    static constexpr int RECONNECT_DEFAULT = 1;
};
 
template <class LocalParams> CDI_GROUP(TcpManualAddress);
CDI_GROUP_ENTRY(ip_address, StringConfigEntry<32>,
    Name(LocalParams::IP_ADDRESS_NAME),
    Description(LocalParams::IP_ADDRESS_DESCR));
CDI_GROUP_ENTRY(port, Uint16ConfigEntry, Name(LocalParams::PORT_NAME),
    Description(LocalParams::PORT_DESCR), Min(1), Max(65535),
    Default(LocalParams::DEFAULT_PORT));
CDI_GROUP_END();
 
template <class LocalParams> CDI_GROUP(TcpAutoAddress);
CDI_GROUP_ENTRY(service_name, StringConfigEntry<48>,
    Name(LocalParams::SERVICE_NAME), Description(LocalParams::SERVICE_DESCR));
CDI_GROUP_ENTRY(host_name, StringConfigEntry<48>, Name(LocalParams::HOST_NAME),
    Description(LocalParams::HOST_DESCR));
CDI_GROUP_END();
 
template <class LocalParams> CDI_GROUP(TcpClientConfig);
// This is of type SocketClientParams::SearchMode.
CDI_GROUP_ENTRY(search_mode, Uint8ConfigEntry,
    Name(LocalParams::SEARCH_MODE_NAME),
    Description(LocalParams::SEARCH_MODE_DESCR), Min(0), Max(3), Default(0),
    MapValues(LocalParams::SEARCH_MODE_MAP));
CDI_GROUP_ENTRY(manual_address, TcpManualAddress<LocalParams>,
    Name(LocalParams::MANUAL_ADDRESS_NAME),
    Description(LocalParams::MANUAL_ADDRESS_DESCR));
CDI_GROUP_ENTRY(auto_address, TcpAutoAddress<LocalParams>,
    Name(LocalParams::AUTO_ADDRESS_NAME),
    Description(LocalParams::AUTO_ADDRESS_DESCR));
CDI_GROUP_ENTRY(reconnect, Uint8ConfigEntry, Name(LocalParams::RECONNECT_NAME),
    Description(LocalParams::RECONNECT_DESCR), Min(0), Max(1),
    Default(LocalParams::RECONNECT_DEFAULT),
    MapValues(LocalParams::RECONNECT_MAP));
CDI_GROUP_ENTRY(last_address, TcpManualAddress<LocalParams>, Hidden(true));
CDI_GROUP_END();
 
} // namespace openlcb
 
#endif // _OPENLCB_CONFIGUREDTCPCONNCTION_HXX_