ReMutexDirect

class ReMutexDirect

This class implements a standard reMutex by making direct calls to the underlying implementation layer. It doesn’t perform any debugging operations.

Inheritance diagram

void acquire(void) const

void acquire(Thread *current_thread) const

Grabs the reMutex if it is available. If it is not available, blocks until it becomes available, then grabs it. In either case, the function does not return until the reMutex is held; you should then call unlock().

This method is considered const so that you can lock and unlock const reMutexes, mainly to allow thread-safe access to otherwise const data.

Also see ReMutexHolder.

This variant on acquire() accepts the current thread as a parameter, if it is already known, as an optimization.

void clear_name(void)

The mutex name is only defined when compiling in DEBUG_THREADS mode.

bool debug_is_locked(void) const

Returns true if the current thread has locked the ReMutex, false otherwise. This method is only intended for use in debugging, hence the method name; in the ReMutexDirect case, it always returns true, since there’s not a reliable way to determine this otherwise.

void elevate_lock(void) const

This method increments the lock count, assuming the calling thread already holds the lock. After this call, release() will need to be called one additional time to release the lock.

This method really performs the same function as acquire(), but it offers a potential (slight) performance benefit when the calling thread knows that it already holds the lock. It is an error to call this when the calling thread does not hold the lock.

std::string get_name(void) const

The mutex name is only defined when compiling in DEBUG_THREADS mode.

bool has_name(void) const

The mutex name is only defined when compiling in DEBUG_THREADS mode.

void output(std::ostream &out) const

This method is declared virtual in MutexDebug, but non-virtual in ReMutexDirect.

void release(void) const

Releases the reMutex. It is an error to call this if the reMutex was not already locked.

This method is considered const so that you can lock and unlock const reMutexes, mainly to allow thread-safe access to otherwise const data.

void set_name(std::string const &name)

The mutex name is only defined when compiling in DEBUG_THREADS mode.

bool try_acquire(void) const

bool try_acquire(Thread *current_thread) const

Returns immediately, with a true value indicating the mutex has been acquired, and false indicating it has not.

Deprecated: Python users should use acquire(False), C++ users try_lock()