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

#include <named_recursive_mutex.hpp>

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

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

	named_recursive_mutex (open_only_t open_only, const char *name)
	Opens a global recursive_mutex with a name if that recursive_mutex is previously created. More...

	~named_recursive_mutex ()
	Destroys *this and indicates that the calling process is finished using the resource. More...

void	unlock ()
	Unlocks a previously locked named_recursive_mutex. More...

void	lock ()
	Locks named_recursive_mutex, sleeps when named_recursive_mutex is already locked. More...

bool	try_lock ()
	Tries to lock the named_recursive_mutex, returns false when named_recursive_mutex is already locked, returns true when success. More...

bool	timed_lock (const boost::posix_time::ptime &abs_time)
	Tries to lock the named_recursive_mutex until time abs_time, Returns false when timeout expires, returns true when locks. More...

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

Friends
class	ipcdetail::interprocess_tester

Detailed Description

A recursive 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_recursive_mutex.

Constructor & Destructor Documentation

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

inline

Creates a global recursive_mutex with a name.

If the recursive_mutex can't be created throws interprocess_exception

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

inline

Opens or creates a global recursive_mutex with a name.

If the recursive_mutex is created, this call is equivalent to named_recursive_mutex(create_only_t, ... ) If the recursive_mutex is already created, this call is equivalent named_recursive_mutex(open_only_t, ... ) Does not throw

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

inline

Opens a global recursive_mutex with a name if that recursive_mutex is previously created.

If it is not previously created this function throws interprocess_exception.

boost::interprocess::named_recursive_mutex::~named_recursive_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().