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(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 |
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.
Definition at line 64 of file Timeout.hpp.
BLOCXX_NAMESPACE::Timeout::Timeout | ( | ) | [private] |
Definition at line 90 of file Timeout.cpp.
BLOCXX_NAMESPACE::Timeout::Timeout | ( | ETimeoutType | type, | |
const DateTime & | dt | |||
) | [private] |
Definition at line 94 of file Timeout.cpp.
BLOCXX_NAMESPACE::Timeout::Timeout | ( | ETimeoutType | type, | |
float | seconds | |||
) | [private] |
Definition at line 100 of file Timeout.cpp.
Definition at line 47 of file Timeout.cpp.
Referenced by BLOCXX_NAMESPACE::TimeoutTimer::asAbsoluteTimeout().
DateTime BLOCXX_NAMESPACE::Timeout::getAbsolute | ( | ) | const |
Definition at line 79 of file Timeout.cpp.
Referenced by BLOCXX_NAMESPACE::TimeoutTimer::calcSeconds(), and BLOCXX_NAMESPACE::TimeoutTimer::expired().
float BLOCXX_NAMESPACE::Timeout::getRelative | ( | ) | const |
Definition at line 85 of file Timeout.cpp.
Referenced by BLOCXX_NAMESPACE::TimeoutTimer::asAbsoluteTimeout(), BLOCXX_NAMESPACE::TimeoutTimer::calcSeconds(), and BLOCXX_NAMESPACE::TimeoutTimer::expired().
Timeout::ETimeoutType BLOCXX_NAMESPACE::Timeout::getType | ( | ) | const |
Definition at line 73 of file Timeout.cpp.
Referenced by BLOCXX_NAMESPACE::TimeoutTimer::asAbsoluteTimeout(), BLOCXX_NAMESPACE::TimeoutTimer::calcSeconds(), BLOCXX_NAMESPACE::TimeoutTimer::expired(), and BLOCXX_NAMESPACE::TimeoutTimer::resetOnLoop().
Timeout BLOCXX_NAMESPACE::Timeout::relative | ( | float | seconds | ) | [static] |
Definition at line 55 of file Timeout.cpp.
Referenced by BLOCXX_NAMESPACE::TimeoutTimer::asRelativeTimeout(), BLOCXX_NAMESPACE::RWLocker::getWriteLock(), BLOCXX_NAMESPACE::ThreadCounter::incThreadCount(), BLOCXX_NAMESPACE::WriteLock::lock(), BLOCXX_NAMESPACE::ReadLock::lock(), BLOCXX_NAMESPACE::ReadLock::ReadLock(), BLOCXX_NAMESPACE::Socket::setConnectTimeout(), BLOCXX_NAMESPACE::UnnamedPipe::setReadTimeout(), BLOCXX_NAMESPACE::Socket::setReceiveTimeout(), BLOCXX_NAMESPACE::Socket::setSendTimeout(), BLOCXX_NAMESPACE::UnnamedPipe::setTimeouts(), BLOCXX_NAMESPACE::Socket::setTimeouts(), BLOCXX_NAMESPACE::UnnamedPipe::setWriteTimeout(), BLOCXX_NAMESPACE::ThreadPool::shutdown(), BLOCXX_NAMESPACE::Semaphore::timedWait(), BLOCXX_NAMESPACE::ThreadPool::tryAddWork(), BLOCXX_NAMESPACE::ThreadCounter::waitForAll(), BLOCXX_NAMESPACE::Socket::waitForInput(), BLOCXX_NAMESPACE::Socket::waitForOutput(), and BLOCXX_NAMESPACE::WriteLock::WriteLock().
Timeout BLOCXX_NAMESPACE::Timeout::relativeWithReset | ( | float | seconds | ) | [static] |
Definition at line 63 of file Timeout.cpp.
Timeout BLOCXX_NAMESPACE::Timeout::infinite = relative(INFINITY) [static] |
Definition at line 62 of file Timeout.hpp.
Referenced by BLOCXX_NAMESPACE::ThreadPool::addWork(), and BLOCXX_NAMESPACE::TimeoutTimer::infinite().
Definition at line 82 of file Timeout.hpp.
float BLOCXX_NAMESPACE::Timeout::m_seconds [private] |
Definition at line 83 of file Timeout.hpp.
Definition at line 81 of file Timeout.hpp.