libstdc++: std::mutex Class Reference

libstdc++

std::mutex Class Reference
Concurrency » Mutexes

`#include <mutex>`

## Public Types
typedef __native_type * | native_handle_type

## Public Member Functions
| mutex (const mutex &)=delete
void | lock ()
native_handle_type | native_handle () noexcept
mutex & | operator= (const mutex &)=delete
bool | try_lock () noexcept
void | unlock ()

## Detailed Description

The standard mutex type.

A simple, non-recursive, non-timed mutex.

Do not call lock() and unlock() directly, use a scoped lock type such as std::unique_lock, std::lock_guard, or (since C++17) std::scoped_lock.

Since
  C++11

Definition at line 99 of file std_mutex.h.

## Member Typedef Documentation

## ◆ native_handle_type

typedef __native_type* std::mutex::native_handle_type

Definition at line 102 of file std_mutex.h.

## Member Function Documentation

## ◆ lock()

void std::mutex::lock | ( |  | ) |
| inline

Definition at line 114 of file std_mutex.h.

## ◆ native_handle()

native_handle_type std::mutex::native_handle | ( |  | ) |
| inlinenoexcept

Definition at line 139 of file std_mutex.h.

## ◆ try_lock()

bool std::mutex::try_lock | ( |  | ) |
| inlinenodiscardnoexcept

Definition at line 125 of file std_mutex.h.

## ◆ unlock()

void std::mutex::unlock | ( |  | ) |
| inline

Definition at line 132 of file std_mutex.h.

The documentation for this class was generated from the following file:

- std_mutex.h