Boost C++ Libraries

interprocess_sharable_mutex(const interprocess_sharable_mutex &);

interprocess_sharable_mutex();

Constructs the sharable lock. Throws interprocess_exception on error.

interprocess_sharable_mutex & operator=(const interprocess_sharable_mutex &);

~interprocess_sharable_mutex();

Destroys the sharable lock. Does not throw.

void lock();

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 or sharable 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.

bool try_lock();

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 or sharable 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> bool timed_lock(const 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 or sharable 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> bool try_lock_until(const TimePoint & abs_time);

Same as timed_lock, but this function is modeled after the standard library interface.

template<typename Duration> bool try_lock_for(const Duration & dur);

Same as timed_lock, but this function is modeled after the standard library interface.

void 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 lock_sharable();

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.

void lock_shared();

Same as lock_sharable but with a std-compatible interface

bool try_lock_sharable();

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.

bool try_lock_shared();

Same as try_lock_sharable but with a std-compatible interface

template<typename TimePoint> 
  bool timed_lock_sharable(const 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> 
  bool try_lock_shared_until(const TimePoint & abs_time);

Same as timed_lock_sharable, but this function is modeled after the standard library interface.

template<typename Duration> bool try_lock_shared_for(const Duration & dur);

Same as timed_lock_sharable, but this function is modeled after the standard library interface.

void 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.

void unlock_shared();

Same as unlock_sharable but with a std-compatible interface