FeeServer::Condition Class Reference
[Threading classes]

#include <feeserver/fee_cond.hh>

List of all members.


Detailed Description

Syncronisation point of threads.

Public Types

enum  Return {
  Success = 0, TimeOut, Interrupt, Busy,
  BadTime
}

Public Member Functions

 Condition ()
 Condition (const Attributes &attr)
virtual ~Condition ()
Return Signal ()
Return Broadcast ()
Return Wait (Mutex &mutex)
Return Wait (Mutex &mutex, const struct timespec &absolute_time)
Return Wait (Mutex &mutex, unsigned int timeout)

Protected Member Functions

Return HandleReturn (int ret) const

Protected Attributes

pthread_cond_t _cond

Classes

class  Attributes
 Conditin attributes. More...

Member Enumeration Documentation

Enumerator:
Success 
TimeOut 
Interrupt 
Busy 
BadTime 


Constructor & Destructor Documentation

FeeServer::Condition::Condition (  ) 

constructor

FeeServer::Condition::Condition ( const Attributes attr  ) 

constructor

FeeServer::Condition::~Condition (  )  [virtual]

Destructor


Member Function Documentation

FeeServer::Condition::Return FeeServer::Condition::Signal (  ) 

Signal the condition

Returns:
true on success, false otherwise

FeeServer::Condition::Return FeeServer::Condition::Broadcast (  ) 

Broad cast the condition

Returns:
true on success, false otherwise

FeeServer::Condition::Return FeeServer::Condition::Wait ( Mutex mutex  ) 

Wait for condition to be signalled

Parameters:
mutex Must be locked on calling this member function. Will be unlocked and relocked when the condition is signalled
Returns:
true on success, false otherwise

FeeServer::Condition::Return FeeServer::Condition::Wait ( Mutex mutex,
const struct timespec &  absolute_time 
)

Timed wait.

Parameters:
mutex Must be locked on calling this member function. Will be unlocked and relocked when the condition is signalled
absolute_time Absolute time (in seconds since epoch) to wait until or give up.
Returns:
true on success, false otherwise

FeeServer::Condition::Return FeeServer::Condition::Wait ( Mutex mutex,
unsigned int  timeout 
)

Timed wait.

Parameters:
mutex Must be locked on calling this member function. Will be unlocked and relocked when condition is signaled.
timeout Time from now to time out in milliseconds.
Returns:
Return value

FeeServer::Condition::Return FeeServer::Condition::HandleReturn ( int  ret  )  const [protected]

Convert return values


Member Data Documentation

pthread_cond_t FeeServer::Condition::_cond [protected]


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

Generated on Thu Jun 26 17:02:29 2008 for FeeServer++ 0.9 by  doxygen 1.5.6