![]() |
Home | Libraries | People | FAQ | More |
boost::interprocess::interprocess_mutex
// In header: <boost/interprocess/sync/interprocess_mutex.hpp> class interprocess_mutex { public: // construct/copy/destruct (); ~(); // public member functions (); (); template<typename TimePoint> (); template<typename TimePoint> (); template<typename Duration> (); (); };
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();
Constructor. Throws interprocess_exception
on error.
~();
Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw.
interprocess_mutex
public member functions();
Requires: The calling thread does not own the mutex.
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.
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 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.
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 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.
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.
();
Effects: The calling thread releases the exclusive ownership of the mutex. Throws: interprocess_exception
on error.