#include <serial.h>

Public Member Functions
virtual timeout	simpleTimeout (const class time &time)
	timeout (const class time &timeInterByteTimeout=0_ms, const class time &timeReadTimeoutConstant=0_ms, ::u32 uReadTimeoutMultiplier=0, const class time &timeWriteTimeoutConstant=0_ms, ::u32 uWriteTimeoutMultiplier=0)
	timeout (nullptr_t)

Static Public Member Functions
::u32	maximum ()

Public Attributes
class::time	m_timeInterByteTimeout
class::time	m_timeReadTimeoutConstant
::u32	m_uReadTimeoutMultiplier
class::time	m_timeWriteTimeoutConstant
::u32	m_uWriteTimeoutMultiplier

Detailed Description

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

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

Member Function Documentation

timeout timeout::simpleTimeout ( const class time & time )

virtual

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

\lparam timeout A long that defines the time in ::times until a timeout occurs after a call to read or write is made.

class::time serial::timeout::m_timeInterByteTimeout

Number of ::times between bytes received to timeout on.

class::time serial::timeout::m_timeReadTimeoutConstant

A constant number of ::times to wait after method read.

class::time serial::timeout::m_timeWriteTimeoutConstant

A constant number of ::times to wait after method write.

::u32 serial::timeout::m_uReadTimeoutMultiplier

A multiplier against the number of requested bytes to wait after method read.

::u32 serial::timeout::m_uWriteTimeoutMultiplier

A multiplier against the number of requested bytes to wait after method write.

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