 |
Boost
v1.57.0
doxygen for www.boost.org
|
|
|
Boost
v1.57.0
doxygen for www.boost.org
|
|
A upgradable mutex with a global name, so it can be found from different processes. More...
#include <named_upgradable_mutex.hpp>
Public Member Functions | |
| named_upgradable_mutex (create_only_t create_only, const char *name, const permissions &perm=permissions()) | |
| Creates a global upgradable mutex with a name. More... | |
| named_upgradable_mutex (open_or_create_t open_or_create, const char *name, const permissions &perm=permissions()) | |
| Opens or creates a global upgradable mutex with a name. More... | |
| named_upgradable_mutex (open_only_t open_only, const char *name) | |
| Opens a global upgradable mutex with a name if that upgradable mutex is previously. More... | |
| ~named_upgradable_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, sharable or upgradable 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, sharable or upgradable 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... | |
| void | lock_upgradable () |
| Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. More... | |
| bool | try_lock_upgradable () |
| Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. More... | |
| bool | timed_lock_upgradable (const boost::posix_time::ptime &abs_time) |
| Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. More... | |
| void | unlock_upgradable () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| void | unlock_and_lock_upgradable () |
| Precondition: The thread must have exclusive ownership of the mutex. More... | |
| void | unlock_and_lock_sharable () |
| Precondition: The thread must have exclusive ownership of the mutex. More... | |
| void | unlock_upgradable_and_lock_sharable () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| void | unlock_upgradable_and_lock () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| bool | try_unlock_upgradable_and_lock () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| bool | timed_unlock_upgradable_and_lock (const boost::posix_time::ptime &abs_time) |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| bool | try_unlock_sharable_and_lock () |
| Precondition: The thread must have sharable ownership of the mutex. More... | |
| bool | try_unlock_sharable_and_lock_upgradable () |
| Precondition: The thread must have sharable ownership of the mutex. More... | |
| named_upgradable_mutex (create_only_t create_only, const char *name, const permissions &perm=permissions()) | |
| Creates a global upgradable mutex with a name. More... | |
| named_upgradable_mutex (open_or_create_t open_or_create, const char *name, const permissions &perm=permissions()) | |
| Opens or creates a global upgradable mutex with a name, and an initial count. More... | |
| named_upgradable_mutex (open_only_t open_only, const char *name) | |
| Opens a global upgradable mutex with a name if that upgradable mutex is previously. More... | |
| ~named_upgradable_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, sharable or upgradable 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, sharable or upgradable 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... | |
| void | lock_upgradable () |
| Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. More... | |
| bool | try_lock_upgradable () |
| Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. More... | |
| bool | timed_lock_upgradable (const boost::posix_time::ptime &abs_time) |
| Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. More... | |
| void | unlock_upgradable () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| void | unlock_and_lock_upgradable () |
| Precondition: The thread must have exclusive ownership of the mutex. More... | |
| void | unlock_and_lock_sharable () |
| Precondition: The thread must have exclusive ownership of the mutex. More... | |
| void | unlock_upgradable_and_lock_sharable () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| void | unlock_upgradable_and_lock () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| bool | try_unlock_upgradable_and_lock () |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| bool | timed_unlock_upgradable_and_lock (const boost::posix_time::ptime &abs_time) |
| Precondition: The thread must have upgradable ownership of the mutex. More... | |
| bool | try_unlock_sharable_and_lock () |
| Precondition: The thread must have sharable ownership of the mutex. More... | |
| bool | try_unlock_sharable_and_lock_upgradable () |
Static Public Member Functions | |
| static bool | remove (const char *name) |
| Erases a named upgradable mutex from the system. More... | |
| static bool | remove (const char *name) |
| Erases a named upgradable mutex from the system. More... | |
Friends | |
| class | named_condition |
| class | ipcdetail::interprocess_tester |
A upgradable 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 upgradable mutex.
|
inline |
Creates a global upgradable mutex with a name.
If the upgradable mutex can't be created throws interprocess_exception
|
inline |
Opens or creates a global upgradable mutex with a name.
If the upgradable mutex is created, this call is equivalent to named_upgradable_mutex(create_only_t, ...) If the upgradable mutex is already created, this call is equivalent to named_upgradable_mutex(open_only_t, ... ).
|
inline |
Opens a global upgradable mutex with a name if that upgradable mutex is previously.
created. If it is not previously created this function throws interprocess_exception.
|
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().
| boost::interprocess::named_upgradable_mutex::named_upgradable_mutex | ( | create_only_t | create_only, |
| const char * | name, | ||
| const permissions & | perm = permissions() |
||
| ) |
Creates a global upgradable mutex with a name.
If the upgradable mutex can't be created throws interprocess_exception
| boost::interprocess::named_upgradable_mutex::named_upgradable_mutex | ( | open_or_create_t | open_or_create, |
| const char * | name, | ||
| const permissions & | perm = permissions() |
||
| ) |
Opens or creates a global upgradable mutex with a name, and an initial count.
If the upgradable mutex is created, this call is equivalent to named_upgradable_mutex(create_only_t, ...) If the upgradable mutex is already created, this call is equivalent to named_upgradable_mutex(open_only_t, ... ).
| boost::interprocess::named_upgradable_mutex::named_upgradable_mutex | ( | open_only_t | open_only, |
| const char * | name | ||
| ) |
Opens a global upgradable mutex with a name if that upgradable mutex is previously.
created. If it is not previously created this function throws interprocess_exception.
| boost::interprocess::named_upgradable_mutex::~named_upgradable_mutex | ( | ) |
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().
|
inline |
Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable 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_upgradable_mutex::lock | ( | ) |
Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership.
Throws: interprocess_exception on error.
|
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.
| void boost::interprocess::named_upgradable_mutex::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.
Throws: interprocess_exception on error.
|
inline |
Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership.
Throws: interprocess_exception on error.
| void boost::interprocess::named_upgradable_mutex::lock_upgradable | ( | ) |
Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership.
Throws: interprocess_exception on error.
|
static |
Erases a named upgradable mutex from the system.
Returns false on error. Never throws.
|
inlinestatic |
Erases a named upgradable mutex from the system.
Returns false on error. Never throws.
References boost::interprocess::shared_memory_object::remove().
|
inline |
Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable 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_upgradable_mutex::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, sharable or upgradable 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_upgradable_mutex::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.
Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.
|
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_upgradable_mutex::timed_lock_upgradable | ( | const boost::posix_time::ptime & | abs_time | ) |
Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached.
Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.
|
inline |
Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached.
Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: interprocess_exception on error.
|
inline |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
| bool boost::interprocess::named_upgradable_mutex::timed_unlock_upgradable_and_lock | ( | const boost::posix_time::ptime & | abs_time | ) |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
|
inline |
Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting.
If no other thread has exclusive, sharable or upgradable 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_upgradable_mutex::try_lock | ( | ) |
Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting.
If no other thread has exclusive, sharable or upgradable 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.
|
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.
| bool boost::interprocess::named_upgradable_mutex::try_lock_sharable | ( | ) |
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.
|
inline |
Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting.
If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.
| bool boost::interprocess::named_upgradable_mutex::try_lock_upgradable | ( | ) |
Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting.
If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: interprocess_exception on error.
| bool boost::interprocess::named_upgradable_mutex::try_unlock_sharable_and_lock | ( | ) |
Precondition: The thread must have sharable ownership of the mutex.
Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have sharable ownership of the mutex.
Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
| bool boost::interprocess::named_upgradable_mutex::try_unlock_sharable_and_lock_upgradable | ( | ) |
|
inline |
Precondition: The thread must have sharable ownership of the mutex.
Effects: The thread atomically releases sharable ownership and tries to acquire upgradable ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
| bool boost::interprocess::named_upgradable_mutex::try_unlock_upgradable_and_lock | ( | ) |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from interprocess_exception on error.
|
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_upgradable_mutex::unlock | ( | ) |
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.
| void boost::interprocess::named_upgradable_mutex::unlock_and_lock_sharable | ( | ) |
Precondition: The thread must have exclusive ownership of the mutex.
Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have exclusive ownership of the mutex.
Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have exclusive ownership of the mutex.
Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.
| void boost::interprocess::named_upgradable_mutex::unlock_and_lock_upgradable | ( | ) |
Precondition: The thread must have exclusive ownership of the mutex.
Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.
| void boost::interprocess::named_upgradable_mutex::unlock_sharable | ( | ) |
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.
|
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.
| void boost::interprocess::named_upgradable_mutex::unlock_upgradable | ( | ) |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release it. Throws: An exception derived from interprocess_exception on error.
| void boost::interprocess::named_upgradable_mutex::unlock_upgradable_and_lock | ( | ) |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release it. Throws: An exception derived from interprocess_exception on error.
| void boost::interprocess::named_upgradable_mutex::unlock_upgradable_and_lock_sharable | ( | ) |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.
|
inline |
Precondition: The thread must have upgradable ownership of the mutex.
Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from interprocess_exception on error.
|
friend |
|
friend |
1.8.8