Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
ConfiguredTcpConnection.hxx File Reference

Go to the source code of this file.

Classes

class  openlcb::TcpClientDefaultParams
 This structure shows what parameters are configurable in the TcpClientConfig CDI group definition. More...
 

Namespaces

namespace  openlcb
 

Functions

template<class LocalParams >
 openlcb::CDI_GROUP (TcpManualAddress)
 
 openlcb::CDI_GROUP_ENTRY (ip_address, StringConfigEntry< 32 >, Name(LocalParams::IP_ADDRESS_NAME), Description(LocalParams::IP_ADDRESS_DESCR))
 
 openlcb::CDI_GROUP_ENTRY (port, Uint16ConfigEntry, Name(LocalParams::PORT_NAME), Description(LocalParams::PORT_DESCR), Min(1), Max(65535), Default(LocalParams::DEFAULT_PORT))
 
 openlcb::CDI_GROUP_END ()
 Signals termination of the group.
 
template<class LocalParams >
 openlcb::CDI_GROUP (TcpAutoAddress)
 
 openlcb::CDI_GROUP_ENTRY (service_name, StringConfigEntry< 48 >, Name(LocalParams::SERVICE_NAME), Description(LocalParams::SERVICE_DESCR))
 
 openlcb::CDI_GROUP_ENTRY (host_name, StringConfigEntry< 48 >, Name(LocalParams::HOST_NAME), Description(LocalParams::HOST_DESCR))
 
template<class LocalParams >
 openlcb::CDI_GROUP (TcpClientConfig)
 
 openlcb::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))
 
 openlcb::CDI_GROUP_ENTRY (manual_address, TcpManualAddress< LocalParams >, Name(LocalParams::MANUAL_ADDRESS_NAME), Description(LocalParams::MANUAL_ADDRESS_DESCR))
 
 openlcb::CDI_GROUP_ENTRY (auto_address, TcpAutoAddress< LocalParams >, Name(LocalParams::AUTO_ADDRESS_NAME), Description(LocalParams::AUTO_ADDRESS_DESCR))
 
 openlcb::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))
 
 openlcb::CDI_GROUP_ENTRY (last_address, TcpManualAddress< LocalParams >, Hidden(true))
 Internal storage for the last working address.
 

Detailed Description

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Persistent configuration for an (outgoing) TCP connection.

Author
Balazs Racz
Date
6 Jan 2019

Definition in file ConfiguredTcpConnection.hxx.