| Home | Libraries | People | FAQ | More

## Class template scoped_lock

boost::interprocess::scoped_lock

## Synopsis

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

    template<typename Mutex>
    class scoped_lock {
    public:
      // types
      typedef Mutex mutex_type;

      // public member functions
      scoped_lock() noexcept;
      explicit scoped_lock(mutex_type &);
      scoped_lock(mutex_type &, defer_lock_type);
      scoped_lock(mutex_type &, accept_ownership_type);
      scoped_lock(mutex_type &, try_to_lock_type);
      template<typename TimePoint> scoped_lock(mutex_type &, const TimePoint &);
      scoped_lock(scoped_lock &&) noexcept;
      template<typename T>
        explicit scoped_lock(upgradable_lock< T > &&, unspecified = 0);
      template<typename T>
        scoped_lock(upgradable_lock< T > &&, try_to_lock_type, unspecified = 0);
      template<typename T, typename TimePoint>
        scoped_lock(upgradable_lock< T > &&, const TimePoint &, unspecified = 0);
      template<typename T>
        scoped_lock(sharable_lock< T > &&, try_to_lock_type, unspecified = 0);
      ~scoped_lock();
      scoped_lock & operator=(scoped_lock &&);
      void lock();
      bool try_lock();
      template<typename TimePoint> bool timed_lock(const TimePoint &);
      template<typename TimePoint> bool try_lock_until(const TimePoint &);
      template<typename Duration> bool try_lock_for(const Duration &);
      void unlock();
      bool owns() const noexcept;
      operator unspecified_bool_type() const noexcept;
      mutex_type * mutex() const noexcept;
      mutex_type * release() noexcept;
      void swap(scoped_lock< mutex_type > &) noexcept;
    };

## Description

scoped_lock is meant to carry out the tasks for locking, unlocking, try-locking and timed-locking (recursive or not) for the Mutex. The Mutex need not supply all of this functionality. If the client of scoped_lock<Mutex> does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership transfer is supported through the syntax of move semantics. Ownership transfer is allowed both by construction and assignment. The scoped_lock does not support copy semantics. A compile time error results if copy construction or copy assignment is attempted. Mutex ownership can also be moved from an upgradable_lock and sharable_lock via constructor. In this role, scoped_lock shares the same functionality as a write_lock.

### `scoped_lock` public member functions

1.     scoped_lock() noexcept;

   Effects: Default constructs a scoped_lock. Postconditions: owns() == false and mutex() == 0.

2.     explicit scoped_lock(mutex_type & m);

   Effects: m.lock(). Postconditions: owns() == true and mutex() == &m. Notes: The constructor will take ownership of the mutex. If another thread already owns the mutex, this thread will block until the mutex is released. Whether or not this constructor handles recursive locking depends upon the mutex.

3.     scoped_lock(mutex_type & m, defer_lock_type);

   Postconditions: owns() == false, and mutex() == &m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex.

4.     scoped_lock(mutex_type & m, accept_ownership_type);

   Postconditions: owns() == true, and mutex() == &m. Notes: The constructor will suppose that the mutex is already locked. There is no effect required on the referenced mutex.

5.     scoped_lock(mutex_type & m, try_to_lock_type);

   Effects: m.try_lock(). Postconditions: mutex() == &m. owns() == the return value of the m.try_lock() executed within the constructor. Notes: The constructor will take ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock, this constructor will fail at compile time if instantiated, but otherwise have no effect.

6.     template<typename TimePoint>
         scoped_lock(mutex_type & m, const TimePoint & abs_time);

   Effects: m.timed_lock(abs_time). Postconditions: mutex() == &m. owns() == the return value of the m.timed_lock(abs_time) executed within the constructor. Notes: The constructor will take ownership of the mutex if it can do it until abs_time is reached. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock, this constructor will fail at compile time if instantiated, but otherwise have no effect.

7.     scoped_lock(scoped_lock && scop) noexcept;

   Postconditions: mutex() == the value scop.mutex() had before the constructor executes. s1.mutex() == 0. owns() == the value of scop.owns() before the constructor executes. scop.owns(). Notes: If the scop scoped_lock owns the mutex, ownership is moved to thisscoped_lock with no blocking. If the scop scoped_lock does not own the mutex, then neither will this scoped_lock. Only a moved scoped_lock's will match this signature. An non-moved scoped_lock can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it.

8.     template<typename T>
         explicit scoped_lock(upgradable_lock< T > && upgr, unspecified = 0);

   Effects: If upgr.owns() then calls unlock_upgradable_and_lock() on the referenced mutex. upgr.release() is called. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0. owns() == upgr.owns() before the construction. upgr.owns() == false after the construction. Notes: If upgr is locked, this constructor will lock this scoped_lock while unlocking upgr. If upgr is unlocked, then this scoped_lock will be unlocked as well. Only a moved upgradable_lock's will match this signature. An non-moved upgradable_lock can be moved with the expression: "boost::move(lock);" This constructor may block if other threads hold a sharable_lock on this mutex (sharable_lock's can share ownership with an upgradable_lock).

9.     template<typename T>
         scoped_lock(upgradable_lock< T > && upgr, try_to_lock_type, unspecified = 0);

   Effects: If upgr.owns() then calls try_unlock_upgradable_and_lock() on the referenced mutex: a)if try_unlock_upgradable_and_lock() returns true then mutex() obtains the value from upgr.release() and owns() is set to true. b)if try_unlock_upgradable_and_lock() returns false then upgr is unaffected and this scoped_lock construction as the same effects as a default construction. c)Else upgr.owns() is false. mutex() obtains the value from upgr.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from upgr immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner.

10.     template<typename T, typename TimePoint>
          scoped_lock(upgradable_lock< T > && upgr, const TimePoint & abs_time,
                      unspecified = 0);

    Effects: If upgr.owns() then calls timed_unlock_upgradable_and_lock(abs_time) on the referenced mutex: a)if timed_unlock_upgradable_and_lock(abs_time) returns true then mutex() obtains the value from upgr.release() and owns() is set to true. b)if timed_unlock_upgradable_and_lock(abs_time) returns false then upgr is unaffected and this scoped_lock construction as the same effects as a default construction. c)Else upgr.owns() is false. mutex() obtains the value from upgr.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from upgr immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner.

11.     template<typename T>
          scoped_lock(sharable_lock< T > && shar, try_to_lock_type, unspecified = 0);

    Effects: If shar.owns() then calls try_unlock_sharable_and_lock() on the referenced mutex. a)if try_unlock_sharable_and_lock() returns true then mutex() obtains the value from shar.release() and owns() is set to true. b)if try_unlock_sharable_and_lock() returns false then shar is unaffected and this scoped_lock construction has the same effects as a default construction. c)Else shar.owns() is false. mutex() obtains the value from shar.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from shar immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner.

12.     ~scoped_lock();

    Effects: if (owns()) mp_mutex->unlock(). Notes: The destructor behavior ensures that the mutex lock is not leaked.*<zwj></zwj>/

13.     scoped_lock & operator=(scoped_lock && scop);

    Effects: If owns() before the call, then unlock() is called on mutex(). *this gets the state of scop and scop gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and scop own the same mutex before the assignment. In this case, this will own the mutex after the assignment (and scop will not), but the mutex's lock count will be decremented by one.

14.     void lock();

    Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls lock() on the referenced mutex. Postconditions: owns() == true. Notes: The scoped_lock changes from a state of not owning the mutex, to owning the mutex, blocking if necessary.

15.     bool try_lock();

    Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock() on the referenced mutex. Postconditions: owns() == the value returned from mutex()->try_lock(). Notes: The scoped_lock changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock(), this function will fail at compile time if instantiated, but otherwise have no effect.*<zwj></zwj>/

16.     template<typename TimePoint> bool timed_lock(const TimePoint & abs_time);

    Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls timed_lock(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-> timed_lock(abs_time). Notes: The scoped_lock changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect.*<zwj></zwj>/

17.     template<typename TimePoint> bool try_lock_until(const TimePoint & abs_time);

    Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock_until(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-> timed_lock(abs_time). Notes: The scoped_lock changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect.*<zwj></zwj>/

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

    Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock_until(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-> timed_lock(abs_time). Notes: The scoped_lock changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect.*<zwj></zwj>/

19.     void unlock();

    Effects: If mutex() == 0 or if not locked, throws a lock_exception() exception. Calls unlock() on the referenced mutex. Postconditions: owns() == false. Notes: The scoped_lock changes from a state of owning the mutex, to not owning the mutex.*<zwj></zwj>/

20.     bool owns() const noexcept;

    Effects: Returns true if this scoped_lock has acquired the referenced mutex.

21.     operator unspecified_bool_type() const noexcept;

    Conversion to bool. Returns owns().

22.     mutex_type * mutex() const noexcept;

    Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference.

23.     mutex_type * release() noexcept;

    Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false.

24.     void swap(scoped_lock< mutex_type > & other) noexcept;

    Effects: Swaps state with moved lock. Throws: Nothing.