DWFCore::DWFSynchronization Interface Reference

#include "dwfcore/Synchronization.h"

Inheritance diagram for DWFCore::DWFSynchronization:

Inheritance graph
[legend]
List of all members.

Detailed Description

This interface should be implemented by all synchronization objects.

Since:
1.0.1

Definition at line 77 of file Synchronization.h.

Public Member Functions

virtual _DWFCORE_API ~DWFSynchronization () throw ()
virtual _DWFCORE_API void init ()=0 throw ( DWFException )
virtual _DWFCORE_API void destroy ()=0 throw ( DWFException )
virtual _DWFCORE_API void lock ()=0 throw ( DWFException )
virtual _DWFCORE_API bool trylock ()=0 throw ( DWFException )
virtual _DWFCORE_API void unlock ()=0 throw ( DWFException )

Protected Member Functions

_DWFCORE_API DWFSynchronization () throw ()


Constructor & Destructor Documentation

virtual _DWFCORE_API DWFCore::DWFSynchronization::~DWFSynchronization  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 88 of file Synchronization.h.

_DWFCORE_API DWFCore::DWFSynchronization::DWFSynchronization  )  throw () [inline, protected]
 

Constructor

Exceptions:
None 

Definition at line 148 of file Synchronization.h.


Member Function Documentation

virtual _DWFCORE_API void DWFCore::DWFSynchronization::destroy  )  throw ( DWFException ) [pure virtual]
 

Destroy the synchronization object. A client must always invoke this method after using this object.

Implemented in DWFCore::DWFThreadMutex, DWFCore::DWFProcessMutex, and DWFCore::DWFSemaphore.

virtual _DWFCORE_API void DWFCore::DWFSynchronization::init  )  throw ( DWFException ) [pure virtual]
 

Initialize the synchronization object. A client must always invoke this method before using this object.

Exceptions:
None 

Implemented in DWFCore::DWFThreadMutex, DWFCore::DWFProcessMutex, and DWFCore::DWFSemaphore.

virtual _DWFCORE_API void DWFCore::DWFSynchronization::lock  )  throw ( DWFException ) [pure virtual]
 

Blocking call to acquire ownership of the synchronization object.

Exceptions:
DWFException 

Implemented in DWFCore::DWFThreadMutex, DWFCore::DWFProcessMutex, and DWFCore::DWFSemaphore.

virtual _DWFCORE_API bool DWFCore::DWFSynchronization::trylock  )  throw ( DWFException ) [pure virtual]
 

Non-blocking call to acquire ownership of the synchronization object. If the object cannot be locked, this method must return immediately.

Returns:
true if the object lock was acquired, false if the call would block waiting for the lock.
Exceptions:
DWFException 

Implemented in DWFCore::DWFThreadMutex, DWFCore::DWFProcessMutex, and DWFCore::DWFSemaphore.

virtual _DWFCORE_API void DWFCore::DWFSynchronization::unlock  )  throw ( DWFException ) [pure virtual]
 

Relinquish ownership of the locked synchronization object.

Exceptions:
DWFException 

Implemented in DWFCore::DWFThreadMutex, DWFCore::DWFProcessMutex, and DWFCore::DWFSemaphore.


The documentation for this interface was generated from the following file:
Generated on Tue Jan 6 22:39:42 2009 for Autodesk DWF Core Library by  doxygen 1.4.5