| Home | Libraries | People | FAQ | More

## Class interprocess_mutex

boost::interprocess::interprocess_mutex

## Synopsis

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

    class interprocess_mutex {
    public:
      // construct/copy/destruct
      interprocess_mutex(const interprocess_mutex &);
      interprocess_mutex();
      interprocess_mutex& operator=(const interprocess_mutex &);
      ~interprocess_mutex();

      // public member functions
      void lock();
      bool try_lock();
      bool timed_lock(const boost::posix_time::ptime &);
      void unlock();
    };

## Description

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

### `interprocess_mutex` public construct/copy/destruct

1.     interprocess_mutex(const interprocess_mutex &);

   @ //Non-copyable

2.     interprocess_mutex();

   Constructor. Throws interprocess_exception on error.

3.     interprocess_mutex& operator=(const interprocess_mutex &);

4.     ~interprocess_mutex();

   Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw.

### `interprocess_mutex` public member functions

1.     void lock();

   Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex, it waits until it can obtain the ownership. If a thread takes ownership of the mutex the mutex must be unlocked by the same mutex. Throws: interprocess_exception on error.

2.     bool try_lock();

   Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex returns immediately. Returns: If the thread acquires ownership of the mutex, returns true, if the another thread has ownership of the mutex, returns false. Throws: interprocess_exception on error.

3.     bool timed_lock(const boost::posix_time::ptime & abs_time);

   Effects: The calling thread will try to obtain exclusive ownership of the mutex if it can do so in until the specified time is reached. If the mutex supports recursive locking, the mutex must be unlocked the same number of times it is locked. Returns: If the thread acquires ownership of the mutex, returns true, if the timeout expires returns false. Throws: interprocess_exception on error.

4.     void unlock();

   Effects: The calling thread releases the exclusive ownership of the mutex. Throws: interprocess_exception on error.