DWFCore::DWFProcessMutex Class Reference
[Platform-specific Class and Function Declarations]

#include "dwfcore/win32/Mutex.h"

Inheritance diagram for DWFCore::DWFProcessMutex:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFProcessMutex:

Collaboration graph
[legend]
List of all members.

Detailed Description

A intra-process synchronization object for Microsoft Windows platforms.

Since:
1.0.1
This mutex is required to provide synchronicity across processes. This particular implementation uses the Win32 kernel mutex. A cross process mutex must be uniquely named so it may be acquired with out relying on any form of inter-process communication.

Note:
This class contains platform-specific data structures but yet still may be used in portable applications via the DWFSynchronization interface.

Definition at line 157 of file win32/Mutex.h.

Public Member Functions

_DWFCORE_API DWFProcessMutex (const DWFString &zName) throw ()
virtual _DWFCORE_API ~DWFProcessMutex () throw ()
_DWFCORE_API void init () throw ( DWFException )
_DWFCORE_API void destroy () throw ( DWFException )
_DWFCORE_API void lock () throw ( DWFException )
_DWFCORE_API bool trylock () throw ( DWFException )
_DWFCORE_API void unlock () throw ( DWFException )
_DWFCORE_API const DWFStringname () const throw ()


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFProcessMutex::DWFProcessMutex const DWFString zName  )  throw ()
 

Constructor

Parameters:
zName The globally available, unique name of this mutex.
Exceptions:
None 

virtual _DWFCORE_API DWFCore::DWFProcessMutex::~DWFProcessMutex  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

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

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

Implements DWFCore::DWFSynchronization.

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

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

Exceptions:
None 

Implements DWFCore::DWFSynchronization.

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

Blocking call to acquire ownership of the synchronization object.

Exceptions:
DWFException 

Implements DWFCore::DWFSynchronization.

_DWFCORE_API const DWFString& DWFCore::DWFProcessMutex::name  )  const throw ()
 

Returns the name of the mutex.

Returns:
The name of the mutex.
Exceptions:
None 

_DWFCORE_API bool DWFCore::DWFProcessMutex::trylock  )  throw ( DWFException ) [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 

Implements DWFCore::DWFSynchronization.

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

Relinquish ownership of the locked synchronization object.

Exceptions:
DWFException 

Implements DWFCore::DWFSynchronization.


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