blocxx
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes

BLOCXX_NAMESPACE::Timeout Class Reference

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

#include <Timeout.hpp>

List of all members.

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 55 of file Timeout.hpp.


Member Enumeration Documentation

Enumerator:
E_ABSOLUTE 
E_RELATIVE 
E_RELATIVE_WITH_RESET 

Definition at line 64 of file Timeout.hpp.


Constructor & Destructor Documentation

BLOCXX_NAMESPACE::Timeout::Timeout ( ) [private]

Definition at line 94 of file Timeout.cpp.

Referenced by absolute(), relative(), and relativeWithReset().

BLOCXX_NAMESPACE::Timeout::Timeout ( ETimeoutType  type,
const DateTime dt 
) [private]

Definition at line 98 of file Timeout.cpp.

BLOCXX_NAMESPACE::Timeout::Timeout ( ETimeoutType  type,
float  seconds 
) [private]

Definition at line 104 of file Timeout.cpp.


Member Function Documentation

usr src packages BUILD blocxx src blocxx Timeout cpp Timeout BLOCXX_NAMESPACE::Timeout::absolute ( const DateTime dt) [static]

Definition at line 51 of file Timeout.cpp.

References E_ABSOLUTE, and Timeout().

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

DateTime BLOCXX_NAMESPACE::Timeout::getAbsolute ( ) const
float BLOCXX_NAMESPACE::Timeout::getRelative ( ) const
Timeout::ETimeoutType BLOCXX_NAMESPACE::Timeout::getType ( ) const
Timeout BLOCXX_NAMESPACE::Timeout::relative ( float  seconds) [static]
Timeout BLOCXX_NAMESPACE::Timeout::relativeWithReset ( float  seconds) [static]

Definition at line 67 of file Timeout.cpp.

References E_RELATIVE_WITH_RESET, and Timeout().


Member Data Documentation

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

Definition at line 82 of file Timeout.hpp.

Referenced by getAbsolute().

Definition at line 83 of file Timeout.hpp.

Referenced by getRelative().

Definition at line 81 of file Timeout.hpp.

Referenced by getType().


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