BLOCXX_NAMESPACE::Timeout Class Reference

A timeout can be absolute, which means that it will happen at the specified DateTime. More...

#include <Timeout.hpp>

Public Types
enum	ETimeoutType { E_ABSOLUTE, E_RELATIVE, E_RELATIVE_WITH_RESET }

Public Member Functions
ETimeoutType	getType () const
DateTime	getAbsolute () const
float	getRelative () const

Static Public Member Functions
static Timeout	absolute (const DateTime &dt)
static Timeout	relative (float seconds)
static Timeout	relativeWithReset (float seconds)

Static Public Attributes
static Timeout	infinite = relative( std::numeric_limits<float>::infinity() )

Private Member Functions
	Timeout ()
	Timeout (ETimeoutType type, const DateTime &dt)
	Timeout (ETimeoutType type, float seconds)

Private Attributes
ETimeoutType	m_type
DateTime	m_absolute
float	m_seconds

Detailed Description

A timeout can be absolute, which means that it will happen at the specified DateTime.

A timeout can be relative, which means that it will happen at the specified interval after the call is made. A timeout can be relative with reset, which means that it will happen at the specified interval after "no activity" has occurred. "no activity" is dependent on the operation. A timeout can be infinite.

Definition at line 85 of file Timeout.hpp.

Member Enumeration Documentation

ETimeoutType

enum BLOCXX_NAMESPACE::Timeout::ETimeoutType

Enumerator
E_ABSOLUTE
E_RELATIVE
E_RELATIVE_WITH_RESET

Definition at line 124 of file Timeout.hpp.

Constructor & Destructor Documentation

Timeout() [1/3]

BLOCXX_NAMESPACE::Timeout::Timeout ( )

private

Definition at line 123 of file Timeout.cpp.

Timeout() [2/3]

BLOCXX_NAMESPACE::Timeout::Timeout ( ETimeoutType  type, const DateTime &  dt  )

private

Definition at line 127 of file Timeout.cpp.

Timeout() [3/3]

BLOCXX_NAMESPACE::Timeout::Timeout ( ETimeoutType  type, float  seconds  )

private

Definition at line 133 of file Timeout.cpp.

Member Function Documentation

absolute()

Timeout BLOCXX_NAMESPACE::Timeout::absolute ( const DateTime &  dt )

static

Definition at line 80 of file Timeout.cpp.

References m_absolute.

getAbsolute()

DateTime BLOCXX_NAMESPACE::Timeout::getAbsolute

(

)

const

Definition at line 112 of file Timeout.cpp.

Referenced by BLOCXX_NAMESPACE::TimeoutTimer::asIntMs().

getRelative()

float BLOCXX_NAMESPACE::Timeout::getRelative

(

)

const

Definition at line 118 of file Timeout.cpp.

getType()

Timeout::ETimeoutType BLOCXX_NAMESPACE::Timeout::getType

(

)

const

Definition at line 106 of file Timeout.cpp.

relative()

Timeout BLOCXX_NAMESPACE::Timeout::relative ( float  seconds )

static

Definition at line 88 of file Timeout.cpp.

References m_seconds.

Referenced by BLOCXX_NAMESPACE::Process::err(), BLOCXX_NAMESPACE::RWLocker::getReadLock(), BLOCXX_NAMESPACE::Process::Process(), BLOCXX_NAMESPACE::ReadLock::ReadLock(), BLOCXX_NAMESPACE::Socket::setReceiveTimeout(), BLOCXX_NAMESPACE::Socket::setSendTimeout(), BLOCXX_NAMESPACE::PosixExec::spawnImpl(), and BLOCXX_NAMESPACE::Socket::write().

relativeWithReset()

Timeout BLOCXX_NAMESPACE::Timeout::relativeWithReset ( float  seconds )

static

Definition at line 96 of file Timeout.cpp.

Member Data Documentation

infinite

Timeout BLOCXX_NAMESPACE::Timeout::infinite = relative( std::numeric_limits<float>::infinity() )

static

Definition at line 122 of file Timeout.hpp.

m_absolute

DateTime BLOCXX_NAMESPACE::Timeout::m_absolute

private

Definition at line 142 of file Timeout.hpp.

Referenced by absolute().

m_seconds

float BLOCXX_NAMESPACE::Timeout::m_seconds

private

Definition at line 143 of file Timeout.hpp.

Referenced by relative().

m_type

ETimeoutType BLOCXX_NAMESPACE::Timeout::m_type

private

Definition at line 141 of file Timeout.hpp.

---

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

• Timeout.hpp
• Timeout.cpp