Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

MCFileMutex Class Reference

File mutex object (NOT IMPLEMENTED). More...

#include <mcllib/MCFileMutex.h>

Inheritance diagram for MCFileMutex:

MCTestMutex MCNonCopy MCMutex List of all members.

Public Member Functions

virtual void lock ()
 Lock the file.
 MCFileMutex (const MCString &fileName, const MCByteRegion &region=MCByteRegion())
 Construct from fileName.
 MCFileMutex (const MCFile &file, const MCByteRegion &region=MCByteRegion())
 Construct from an MCFile.
virtual bool testLock ()
 Try and lock the file.
virtual void unlock ()
 Unlock the file.
virtual ~MCFileMutex ()
 Destructor.

Detailed Description

File mutex object (NOT IMPLEMENTED).

Obtains a lock on a file object.

Todo:
Implement file locking


Constructor & Destructor Documentation

virtual ~MCFileMutex  )  [virtual]
 

Destructor.

Unlock if the file is locked


Member Function Documentation

virtual void lock  )  [virtual]
 

Lock the file.

Blocks until the file can be locked

Implements MCMutex.

virtual bool testLock  )  [virtual]
 

Try and lock the file.

If successful (and the file is now locked), return true, otherwise return false

Implements MCTestMutex.


Generated on Wed Jan 12 19:05:49 2005 for MCLLIB by  doxygen 1.3.9.1