tbb::mutex Class Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

Classes | Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
tbb::mutex Class Reference
Synchronization

Wrapper around the platform's native lock. More...

`#include <mutex.h>`

Inheritance diagram for tbb::mutex:

## Classes
class | scoped_lock
| The scoped locking pattern. More...

## Public Types
enum | state_t { INITIALIZED =0x1234, DESTROYED =0x789A, HELD =0x56CD }
typedef LPCRITICAL_SECTION | native_handle_type
| Return native_handle.
typedef pthread_mutex_t * | native_handle_type

## Public Member Functions
| mutex ()
| Construct unacquired mutex.
void | lock ()
| Acquire lock.
bool | try_lock ()
| Try acquiring lock (non-blocking) More...
void | unlock ()
| Release lock.
native_handle_type | native_handle ()
void | set_state (state_t to)
| Set the internal state.

## Static Public Attributes
static const bool | is_rw_mutex = false
static const bool | is_recursive_mutex = false
static const bool | is_fair_mutex = false

## Friends
class | scoped_lock

## Detailed Description

Wrapper around the platform's native lock.

## Member Function Documentation

bool tbb::mutex::try_lock | ( |  | ) |
| inline

Try acquiring lock (non-blocking)

Return true if lock acquired; false otherwise.

References tbb::aligned_space< T, N >::begin().

Referenced by tbb::mutex::scoped_lock::try_acquire().

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

- mutex.h

Copyright © 2005-2018 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.