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

#include <named_mutex.hpp>

Public Types
typedef interprocess_mutex	internal_mutex_type

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

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

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

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

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

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

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

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

interprocess_mutex &	internal_mutex ()

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

Friends
class	named_condition

class	ipcdetail::interprocess_tester

Detailed Description

A 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 mutex.

Member Typedef Documentation

typedef interprocess_mutex boost::interprocess::ipcdetail::shm_named_mutex::internal_mutex_type

Constructor & Destructor Documentation

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

inline

Creates a global interprocess_mutex with a name.

Throws interprocess_exception on error.

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

inline

Opens or creates a global mutex with a name.

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

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

inline

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

If it is not previously created this function throws interprocess_exception.

boost::interprocess::ipcdetail::shm_named_mutex::~shm_named_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().