#include <structs.hpp>

Public Member Functions
	Timeout (const uint32_t _interByteTimeout=0, const uint32_t _readTimeoutConstant=0, const uint32_t _readTimeoutMultiplier=0, const uint32_t _writeTimeoutConstant=0, const uint32_t _writeTimeoutMultiplier=0)

Static Public Member Functions
static uint32_t	max ()

static iv::comms::serial::Timeout	simpleTimeout (const uint32_t timeout)

Public Attributes
uint32_t	interByteTimeout

uint32_t	readTimeoutConstant

uint32_t	readTimeoutMultiplier

uint32_t	writeTimeoutConstant

uint32_t	writeTimeoutMultiplier

Detailed Description

Structure for setting the timeout of the serial port, times are in milliseconds.

In order to disable the interbyte timeout, set it to Timeout::max().

Constructor & Destructor Documentation

◆ Timeout()

iv::comms::serial::Timeout::Timeout	(	const uint32_t	_interByteTimeout = 0,
		const uint32_t	_readTimeoutConstant = 0,
		const uint32_t	_readTimeoutMultiplier = 0,
		const uint32_t	_writeTimeoutConstant = 0,
		const uint32_t	_writeTimeoutMultiplier = 0 )

inlineexplicit

Member Function Documentation

◆ max()

static uint32_t iv::comms::serial::Timeout::max ( )

inlinestatic

◆ simpleTimeout()

static iv::comms::serial::Timeout iv::comms::serial::Timeout::simpleTimeout ( const uint32_t timeout )

inlinestatic

Convenience function to generate Timeout structs using a single absolute timeout.

Parameters

timeout A int64_t that defines the time in milliseconds until a timeout occurs after a call to read or write is made.

Returns: Timeout struct that represents this simple timeout provided.

Member Data Documentation

◆ interByteTimeout

uint32_t iv::comms::serial::Timeout::interByteTimeout

◆ readTimeoutConstant

uint32_t iv::comms::serial::Timeout::readTimeoutConstant

◆ readTimeoutMultiplier

uint32_t iv::comms::serial::Timeout::readTimeoutMultiplier

◆ writeTimeoutConstant

uint32_t iv::comms::serial::Timeout::writeTimeoutConstant

◆ writeTimeoutMultiplier

uint32_t iv::comms::serial::Timeout::writeTimeoutMultiplier

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

src/comms/serial/structs.hpp

Public Member Functions

Static Public Member Functions

Public Attributes