folly::shared_mutex_detail::annotationGuard

Returns a guard that gives permission for the current thread to annotate, and adjust the annotation bits in, the SharedMutex at ptr.

Synopsis

Declared in <folly/SharedMutex.h>

std::unique_lock<std::mutex>
annotationGuard(void* ptr);

Return Value

A lock guarding annotation access to the given mutex.

Parameters

NameDescription
ptrPointer to the SharedMutex whose annotation bits are guarded.