gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OSLock Class Referenceabstract

#include <avbts_oslock.hpp>

Inheritance diagram for OSLock:
Inheritance graph
Collaboration diagram for OSLock:
Collaboration graph

Public Member Functions

virtual OSLockResult lock ()=0
 Locks a critical section. More...
 
virtual OSLockResult unlock ()=0
 Unlocks a critical section. More...
 
virtual OSLockResult trylock ()=0
 Tries locking a critical section. More...
 

Protected Member Functions

 OSLock ()
 
bool initialize (OSLockType type)
 Initializes locking mechanism. More...
 

Detailed Description

Provides a generic mechanism for locking critical sections.

Constructor & Destructor Documentation

OSLock::OSLock ( )
inlineprotected

Default constructor

Member Function Documentation

bool OSLock::initialize ( OSLockType  type)
inlineprotected

Initializes locking mechanism.

Parameters
typeEnumeration OSLockType
Returns
FALSE
virtual OSLockResult OSLock::lock ( )
pure virtual

Locks a critical section.

Returns
OSLockResult enumeration

Implemented in LinuxLock, and WindowsLock.

virtual OSLockResult OSLock::trylock ( )
pure virtual

Tries locking a critical section.

Returns
OSLockResult enumeration

Implemented in LinuxLock, and WindowsLock.

virtual OSLockResult OSLock::unlock ( )
pure virtual

Unlocks a critical section.

Returns
OSLockResult enumeration

Implemented in LinuxLock, and WindowsLock.


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