mutex Class (STL)

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at mutex Class (C++ Standard Library)| Microsoft Docs.

Represents a mutex type. Objects of this type can be used to enforce mutual exclusion within a program.

class mutex;

Public Constructors

NameDescription
mutex::mutex ConstructorConstructs a mutex object.
mutex::~mutex DestructorReleases any resources that were used by the mutex object.

Public Methods

NameDescription
mutex::lock MethodBlocks the calling thread until the thread obtains ownership of the mutex.
mutex::native_handle MethodReturns the implementation-specific type that represents the mutex handle.
mutex::try_lock MethodAttempts to obtain ownership of the mutex without blocking.
mutex::unlock MethodReleases ownership of the mutex.

Header: mutex

Namespace: std

Blocks the calling thread until the thread obtains ownership of the mutex.

void lock();

Remarks

If the calling thread already owns the mutex, the behavior is undefined.

Constructs a mutex object that is not locked.

constexpr mutex() noexcept;

Releases any resources that are used by the mutex object.

~mutex();

Remarks

If the object is locked when the destructor runs, the behavior is undefined.

Returns the implementation-specific type that represents the mutex handle. The mutex handle can be used in implementation-specific ways.

native_handle_type native_handle();

Return Value

native_handle_type is defined as a Concurrency::critical_section * that's cast as void *.

Attempts to obtain ownership of the mutex without blocking.

bool try_lock();

Return Value

true if the method successfully obtains ownership of the mutex; otherwise, false.

Remarks

If the calling thread already owns the mutex, the behavior is undefined.

Releases ownership of the mutex.

void unlock();

Remarks

If the calling thread does not own the mutex, the behavior is undefined.

Header Files Reference
<mutex>

Show: