$darkmode
cloe::utility::TcpTransceiverConfiguration Struct Reference

#include <tcp_transceiver_config.hpp>

Inheritance diagram for cloe::utility::TcpTransceiverConfiguration:
Collaboration diagram for cloe::utility::TcpTransceiverConfiguration:

Public Member Functions

 TcpTransceiverConfiguration (int32_t attempts, std::chrono::duration< float > delay)
 
 CONFABLE_SCHEMA (TcpTransceiverConfiguration)
 
void to_json (Json &j) const override
 
- Public Member Functions inherited from fable::Confable
 Confable (const Confable &) noexcept
 
 Confable (Confable &&) noexcept=default
 
Confableoperator= (const Confable &other) noexcept
 
Confableoperator= (Confable &&other) noexcept
 
virtual void reset_schema ()
 
Schemaschema ()
 
const Schemaschema () const
 
virtual void validate_or_throw (const Conf &c) const
 
virtual bool validate (const Conf &c, std::optional< SchemaError > &err) const
 
virtual void from_conf (const Conf &c)
 
virtual void to_json (Json &j) const
 
Json to_json () const
 

Public Attributes

int32_t retry_attempts {60}
 
std::chrono::duration< float > retry_delay {1.0}
 

Additional Inherited Members

- Protected Member Functions inherited from fable::Confable
virtual Schema schema_impl ()
 

Detailed Description

This configuration struct is meant to be re-used in various other configuration blocks for connection configuration.

Member Data Documentation

◆ retry_attempts

int32_t cloe::utility::TcpTransceiverConfiguration::retry_attempts {60}

Retry attempts is the number of attempts to retry after connection failure. The value 0 indicates no attempts and is effectively the same as not using this factory. Any negative value indicates an infinite number of connection attempts; this is not recommended, but can be useful in certain circumstances.

◆ retry_delay

std::chrono::duration<float> cloe::utility::TcpTransceiverConfiguration::retry_delay {1.0}

The retry delay is the fraction of time in seconds that should be waited between connection attempts. The value 0 indicates that no time is waited, and is not recommended, as this can tie up your system.


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