![]() |
Home | Libraries | People | FAQ | More |
boost::interprocess::interprocess_upgradable_mutex
// In header: <boost/interprocess/sync/interprocess_upgradable_mutex.hpp> class interprocess_upgradable_mutex { public: // construct/copy/destruct (interprocess_upgradable_mutex &); (); interprocess_upgradable_mutex & (interprocess_upgradable_mutex &); ~(); // public member functions (); (); template<typename TimePoint> (); template<typename TimePoint> (); template<typename Duration> (); (); (); (); (); (); template<typename TimePoint> (); template<typename TimePoint> (); template<typename Duration> (); (); (); (); (); template<typename TimePoint> (); (); (); (); (); (); (); template<typename TimePoint> (); (); (); };
Wraps a interprocess_upgradable_mutex that can be placed in shared memory and can be shared between processes. Allows timed lock tries
interprocess_upgradable_mutex
public
construct/copy/destruct(interprocess_upgradable_mutex &);
();
Constructs the upgradable lock. Throws interprocess_exception
on error.
interprocess_upgradable_mutex & (interprocess_upgradable_mutex &);
~();
Destroys the upgradable lock. Does not throw.
interprocess_upgradable_mutex
public member functions();
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
();
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
template<typename TimePoint> ( abs_time);
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
template<typename TimePoint> ( abs_time);
Same as timed_lock
, but this function is modeled after the standard library interface.
template<typename Duration> ( dur);
Same as timed_lock
, but this function is modeled after the standard library interface.
();
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.
();
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
();
Same as lock_sharable
but with a std-compatible interface
();
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
();
Same as try_lock_sharable
but with a std-compatible interface
template<typename TimePoint> ( abs_time);
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
template<typename TimePoint> ( abs_time);
Same as timed_lock_sharable
, but this function is modeled after the standard library interface.
template<typename Duration> ( dur);
Same as timed_lock_sharable
, but this function is modeled after the standard library interface.
();
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.
();
Same as unlock_sharable
but with a std-compatible interface
();
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
();
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
template<typename TimePoint> ( abs_time);
Requires: The calling thread does not own the mutex.
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.
Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown.
();
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.
();
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.
();
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.
();
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.
();
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 their sharable lock. Throws: An exception derived from interprocess_exception
on error.
();
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.
template<typename TimePoint> ( 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. *<zwj></zwj>/
();
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.
();
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.