unilink  0.4.3
A simple C++ library for unified async communication
unilink::config::SerialConfig Struct Reference

#include <serial_config.hpp>

Public Types

enum class  Parity { None , Even , Odd }
 
enum class  Flow { None , Software , Hardware }
 

Public Member Functions

bool is_valid () const
 
void validate_and_clamp ()
 

Public Attributes

std::string device = "/dev/ttyUSB0"
 
unsigned baud_rate = 115200
 
unsigned char_size = 8
 
enum unilink::config::SerialConfig::Parity parity = Parity::None
 
unsigned stop_bits = 1
 
enum unilink::config::SerialConfig::Flow flow = Flow::None
 
size_t read_chunk = common::constants::DEFAULT_READ_BUFFER_SIZE
 
bool reopen_on_error = true
 
size_t backpressure_threshold = common::constants::DEFAULT_BACKPRESSURE_THRESHOLD
 
bool enable_memory_pool = true
 
bool stop_on_callback_exception = false
 
unsigned retry_interval_ms = common::constants::DEFAULT_RETRY_INTERVAL_MS
 
int max_retries = common::constants::DEFAULT_MAX_RETRIES
 

Detailed Description

Definition at line 26 of file serial_config.hpp.

Member Enumeration Documentation

◆ Flow

Enumerator
None 
Software 
Hardware 

Definition at line 36 of file serial_config.hpp.

◆ Parity

Enumerator
None 
Even 
Odd 

Definition at line 34 of file serial_config.hpp.

Member Function Documentation

◆ is_valid()

bool unilink::config::SerialConfig::is_valid ( ) const
inline

Definition at line 49 of file serial_config.hpp.

◆ validate_and_clamp()

void unilink::config::SerialConfig::validate_and_clamp ( )
inline

Definition at line 59 of file serial_config.hpp.

Member Data Documentation

◆ backpressure_threshold

size_t unilink::config::SerialConfig::backpressure_threshold = common::constants::DEFAULT_BACKPRESSURE_THRESHOLD

Definition at line 40 of file serial_config.hpp.

◆ baud_rate

unsigned unilink::config::SerialConfig::baud_rate = 115200

Definition at line 32 of file serial_config.hpp.

◆ char_size

unsigned unilink::config::SerialConfig::char_size = 8

Definition at line 33 of file serial_config.hpp.

◆ device

std::string unilink::config::SerialConfig::device = "/dev/ttyUSB0"

Definition at line 30 of file serial_config.hpp.

◆ enable_memory_pool

bool unilink::config::SerialConfig::enable_memory_pool = true

Definition at line 41 of file serial_config.hpp.

◆ flow

enum unilink::config::SerialConfig::Flow unilink::config::SerialConfig::flow = Flow::None

◆ max_retries

int unilink::config::SerialConfig::max_retries = common::constants::DEFAULT_MAX_RETRIES

Definition at line 46 of file serial_config.hpp.

◆ parity

enum unilink::config::SerialConfig::Parity unilink::config::SerialConfig::parity = Parity::None

◆ read_chunk

size_t unilink::config::SerialConfig::read_chunk = common::constants::DEFAULT_READ_BUFFER_SIZE

Definition at line 38 of file serial_config.hpp.

◆ reopen_on_error

bool unilink::config::SerialConfig::reopen_on_error = true

Definition at line 39 of file serial_config.hpp.

◆ retry_interval_ms

unsigned unilink::config::SerialConfig::retry_interval_ms = common::constants::DEFAULT_RETRY_INTERVAL_MS

Definition at line 45 of file serial_config.hpp.

◆ stop_bits

unsigned unilink::config::SerialConfig::stop_bits = 1

Definition at line 35 of file serial_config.hpp.

◆ stop_on_callback_exception

bool unilink::config::SerialConfig::stop_on_callback_exception = false

Definition at line 43 of file serial_config.hpp.


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