A file lock, is a mutual exclusion utility similar to a mutex using a file. More...

#include <file_lock.hpp>

Public Member Functions
	file_lock ()
	Constructs an empty file mapping. More...

	file_lock (const char *name)
	Opens a file lock. More...

	file_lock (BOOST_RV_REF(file_lock) moved)
	Moves the ownership of "moved"'s file mapping object to *this. More...

file_lock &	operator= (BOOST_RV_REF(file_lock) moved)
	Moves the ownership of "moved"'s file mapping to *this. More...

	~file_lock ()
	Closes a file lock. Does not throw. More...

void	swap (file_lock &other)
	Swaps two file_locks. More...

void	lock ()
	Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, or sharable ownership of the mutex, it waits until it can obtain the ownership. More...

bool	try_lock ()
	Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. More...

bool	timed_lock (const boost::posix_time::ptime &abs_time)
	Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached. More...

void	unlock ()
	Precondition: The thread must have exclusive ownership of the mutex. More...

void	lock_sharable ()
	Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. More...

bool	try_lock_sharable ()
	Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. More...

bool	timed_lock_sharable (const boost::posix_time::ptime &abs_time)
	Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. More...

void	unlock_sharable ()
	Precondition: The thread must have sharable ownership of the mutex. More...

Detailed Description

A file lock, is a mutual exclusion utility similar to a mutex using a file.

A file lock has sharable and exclusive locking capabilities and can be used with scoped_lock and sharable_lock classes. A file lock can't guarantee synchronization between threads of the same process so just use file locks to synchronize threads from different processes.

Constructor & Destructor Documentation

boost::interprocess::file_lock::file_lock ( )

inline

Constructs an empty file mapping.

Does not throw

boost::interprocess::file_lock::file_lock ( const char * name )

inline

Opens a file lock.

Throws interprocess_exception if the file does not exist or there are no operating system resources.

References boost::interprocess::system_error_code().

boost::interprocess::file_lock::file_lock ( BOOST_RV_REF(file_lock) moved )

inline

Moves the ownership of "moved"'s file mapping object to *this.

After the call, "moved" does not represent any file mapping object. Does not throw

References swap().

boost::interprocess::file_lock::~file_lock ( )

inline

Closes a file lock. Does not throw.

Member Function Documentation

void boost::interprocess::file_lock::lock ( )

inline

Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, or sharable ownership of the mutex, it waits until it can obtain the ownership.

Throws: interprocess_exception on error.

References boost::interprocess::system_error_code().

void boost::interprocess::file_lock::lock_sharable ( )

inline

Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership.

Throws: interprocess_exception on error.

References boost::interprocess::system_error_code().

file_lock& boost::interprocess::file_lock::operator= ( BOOST_RV_REF(file_lock) moved )

inline

Moves the ownership of "moved"'s file mapping to *this.

After the call, "moved" does not represent any file mapping. Does not throw

References boost::move(), and swap().

void boost::interprocess::file_lock::swap ( file_lock & other )

inline

Swaps two file_locks.

Does not throw.

Referenced by file_lock(), and operator=().

bool boost::interprocess::file_lock::timed_lock ( const boost::posix_time::ptime & abs_time )

inline

Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached.

Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.

bool boost::interprocess::file_lock::timed_lock_sharable ( const boost::posix_time::ptime & abs_time )

inline

Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached.

Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.

bool boost::interprocess::file_lock::try_lock ( )

inline

Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting.

If no other thread has exclusive, or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.

References boost::interprocess::system_error_code().

bool boost::interprocess::file_lock::try_lock_sharable ( )

inline

Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting.

If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.

References boost::interprocess::system_error_code().

void boost::interprocess::file_lock::unlock ( )

inline

Precondition: The thread must have exclusive ownership of the mutex.

Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::system_error_code().

void boost::interprocess::file_lock::unlock_sharable ( )

inline

Precondition: The thread must have sharable ownership of the mutex.

Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from interprocess_exception on error.

References boost::interprocess::system_error_code().

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

boost_1_57_0/boost/interprocess/sync/file_lock.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation