Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class interprocess_sharable_mutex

boost::interprocess::interprocess_sharable_mutex

Synopsis

// In header: <boost/interprocess/sync/interprocess_sharable_mutex.hpp>


class interprocess_sharable_mutex {
public:
  // construct/copy/destruct
  (interprocess_sharable_mutex &);
  ();
  interprocess_sharable_mutex & (interprocess_sharable_mutex &);
  ~();

  // public member functions
   ();
   ();
  template<typename TimePoint>  ();
  template<typename TimePoint>  ();
  template<typename Duration>  ();
   ();
   ();
   ();
   ();
   ();
  template<typename TimePoint>  ();
  template<typename TimePoint>  ();
  template<typename Duration>  ();
   ();
   ();
};

Description

Wraps a interprocess_sharable_mutex that can be placed in shared memory and can be shared between processes. Allows timed lock tries

interprocess_sharable_mutex public construct/copy/destruct

  1. (interprocess_sharable_mutex &);
  2. ();

    Constructs the sharable lock. Throws interprocess_exception on error.

  3. interprocess_sharable_mutex & (interprocess_sharable_mutex &);
  4. ~();

    Destroys the sharable lock. Does not throw.

interprocess_sharable_mutex public member functions

  1.  ();

    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.

  2.  ();

    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.

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

  4. template<typename TimePoint>  ( abs_time);

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

  5. template<typename Duration>  ( dur);

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

  6.  ();

    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.

  7.  ();

    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.

  8.  ();

    Same as lock_sharable but with a std-compatible interface

  9.  ();

    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.

  10.  ();

    Same as try_lock_sharable but with a std-compatible interface

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

  12. template<typename TimePoint> 
       ( abs_time);

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

  13. template<typename Duration>  ( dur);

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

  14.  ();

    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.

  15.  ();

    Same as unlock_sharable but with a std-compatible interface


PrevUpHomeNext