gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
OSCondition Class Referenceabstract

#include <avbts_oscondition.hpp>

Inheritance diagram for OSCondition:
Inheritance graph
Collaboration diagram for OSCondition:
Collaboration graph

Public Member Functions

virtual bool wait ()=0
 Waits until a condition is met. More...
 
virtual bool wait_prelock ()=0
 Waits for lock. More...
 
virtual bool signal ()=0
 Sends a signal to unblock other threads. More...
 
virtual ~OSCondition ()=0
 

Protected Member Functions

 OSCondition ()
 
void up ()
 Counts up waiting condition. More...
 
void down ()
 Conds down waiting condition. More...
 
bool waiting ()
 Checks if OS is waiting. More...
 

Detailed Description

Provides a generic interface for OS's locking condition

Constructor & Destructor Documentation

OSCondition::~OSCondition ( )
inlinepure virtual

Deletes previously declared flags

OSCondition::OSCondition ( )
inlineprotected

Default constructor. Initializes internal variables

Member Function Documentation

void OSCondition::down ( )
inlineprotected

Conds down waiting condition.

Returns
void
virtual bool OSCondition::signal ( )
pure virtual

Sends a signal to unblock other threads.

Returns
TRUE

Implemented in LinuxCondition, and WindowsCondition.

void OSCondition::up ( )
inlineprotected

Counts up waiting condition.

Returns
void
virtual bool OSCondition::wait ( )
pure virtual

Waits until a condition is met.

Returns
TRUE after waiting

Implemented in LinuxCondition, and WindowsCondition.

virtual bool OSCondition::wait_prelock ( )
pure virtual

Waits for lock.

Returns
TRUE after waiting

Implemented in LinuxCondition, and WindowsCondition.

bool OSCondition::waiting ( )
inlineprotected

Checks if OS is waiting.

Returns
TRUE if up counter is greater than zero. FALSE otherwise.
The documentation for this class was generated from the following file: