A global condition variable that can be created by name. More...

#include <named_condition.hpp>

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

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

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

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

*void	notify_one ()
	If there is a thread waiting on *this, change that thread's state to ready. More...

void	notify_all ()
	Change the state of all threads waiting on *this to ready. More...

template<typename L >
void	wait (L &lock)
	Releases the lock on the named_mutex object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), and then reacquires the lock. More...

template<typename L , typename Pr >
void	wait (L &lock, Pr pred)
	The same as: while (!pred()) wait(lock) More...

template<typename L >
bool	timed_wait (L &lock, const boost::posix_time::ptime &abs_time)
	Releases the lock on the named_mutex object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), or until time abs_time is reached, and then reacquires the lock. More...

template<typename L , typename Pr >
bool	timed_wait (L &lock, const boost::posix_time::ptime &abs_time, Pr pred)
	The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true;. More...

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

Friends
class	ipcdetail::interprocess_tester

Detailed Description

A global condition variable that can be created by name.

This condition variable is designed to work with named_mutex and can't be placed in shared memory or memory mapped files.

Constructor & Destructor Documentation

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

inline

Creates a global condition with a name.

If the condition can't be created throws interprocess_exception

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

inline

Opens or creates a global condition with a name.

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

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

inline

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

If it is not previously created this function throws interprocess_exception.

boost::interprocess::named_condition::~named_condition ( )

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_condition::notify_all ( )

inline

Change the state of all threads waiting on *this to ready.

If there are no waiting threads, notify_all() has no effect.

References boost::interprocess::ipcdetail::shm_named_condition::notify_all().

void boost::interprocess::named_condition::notify_one ( )

inline

If there is a thread waiting on *this, change that thread's state to ready.

Otherwise there is no effect.

References boost::interprocess::ipcdetail::shm_named_condition::notify_one().

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

inlinestatic

Erases a named condition from the system.

Returns false on error. Never throws.

References boost::interprocess::ipcdetail::shm_named_condition::remove().

template<typename L >

bool boost::interprocess::named_condition::timed_wait	(	L &	lock,
		const boost::posix_time::ptime &	abs_time
	)

inline

Releases the lock on the named_mutex object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), or until time abs_time is reached, and then reacquires the lock.

Returns: false if time abs_time is reached, otherwise true.

template<typename L , typename Pr >

bool boost::interprocess::named_condition::timed_wait	(	L &	lock,
		const boost::posix_time::ptime &	abs_time,
		Pr	pred
	)

inline

The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true;.

template<typename L >

void boost::interprocess::named_condition::wait ( L & lock )

inline

Releases the lock on the named_mutex object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), and then reacquires the lock.

References boost::interprocess::ipcdetail::shm_named_condition::wait().

template<typename L , typename Pr >

void boost::interprocess::named_condition::wait	(	L &	lock,
		Pr	pred
	)

inline

The same as: while (!pred()) wait(lock)

References boost::interprocess::ipcdetail::shm_named_condition::wait().

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_condition.hpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation