A sharable mutex with a global name, so it can be found from different processes. More...

#include <named_sharable_mutex.hpp>

Public Member Functions
	named_sharable_mutex (create_only_t create_only, const char *name, const permissions &perm=permissions())
	Creates a global sharable mutex with a name. More...

	named_sharable_mutex (open_or_create_t open_or_create, const char *name, const permissions &perm=permissions())
	Opens or creates a global sharable mutex with a name. More...

	named_sharable_mutex (open_only_t open_only, const char *name)
	Opens a global sharable mutex with a name if that sharable mutex is previously. More...

	~named_sharable_mutex ()
	Destroys *this and indicates that the calling process is finished using the resource. 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...

Static Public Member Functions
static bool	remove (const char *name)
	Erases a named sharable mutex from the system. More...

Friends
class	ipcdetail::interprocess_tester

Detailed Description

A sharable mutex with a global name, so it can be found from different processes.

This mutex can't be placed in shared memory, and each process should have it's own named sharable mutex.

Constructor & Destructor Documentation

boost::interprocess::named_sharable_mutex::named_sharable_mutex	(	create_only_t	create_only,
		const char *	name,
		const permissions &	perm = `permissions()`
	)

inline

Creates a global sharable mutex with a name.

If the sharable mutex can't be created throws interprocess_exception

boost::interprocess::named_sharable_mutex::named_sharable_mutex	(	open_or_create_t	open_or_create,
		const char *	name,
		const permissions &	perm = `permissions()`
	)

inline

Opens or creates a global sharable mutex with a name.

If the sharable mutex is created, this call is equivalent to named_sharable_mutex(create_only_t, ...) If the sharable mutex is already created, this call is equivalent to named_sharable_mutex(open_only_t, ... ).

boost::interprocess::named_sharable_mutex::named_sharable_mutex	(	open_only_t	open_only,
		const char *	name
	)

inline

Opens a global sharable mutex with a name if that sharable mutex is previously.

created. If it is not previously created this function throws interprocess_exception.

boost::interprocess::named_sharable_mutex::~named_sharable_mutex ( )

inline

Destroys *this and indicates that the calling process is finished using the resource.

The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove().

Member Function Documentation

void boost::interprocess::named_sharable_mutex::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::mutex::lock().

void boost::interprocess::named_sharable_mutex::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.

bool boost::interprocess::named_sharable_mutex::remove ( const char * name )

inlinestatic

Erases a named sharable mutex from the system.

Returns false on error. Never throws.

References boost::interprocess::shared_memory_object::remove().

bool boost::interprocess::named_sharable_mutex::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::named_sharable_mutex::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::named_sharable_mutex::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::mutex::try_lock().

bool boost::interprocess::named_sharable_mutex::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.

void boost::interprocess::named_sharable_mutex::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::mutex::unlock().

void boost::interprocess::named_sharable_mutex::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.

Friends And Related Function Documentation

friend class ipcdetail::interprocess_tester

friend

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

boost_1_57_0/boost/interprocess/sync/named_sharable_mutex.hpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation