1. Epic GamesDeveloper
  3. FExternalMutex

FExternalMutex

A mutex which takes it state from an external source and uses only its 2 LSBs.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Async

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Async/ExternalMutex.h
Include #include "Async/ExternalMutex.h"

Syntax

class FExternalMutex

Remarks

A mutex which takes it state from an external source and uses only its 2 LSBs. The external source must ensure that the state is valid for the lifetime of the mutex.

Note: Changes to this class should also be ported to FMutex. These classes could be merged via templatization but we would want to make sure this doesn't cause any undesired code-bloat / side effects.

Constructors

  Type Name Description
Public function constexpr

FExternalMutex ( std::atomic< uint8 >& InState
)

  
Public function    
Public function  

FExternalMutex ( std::atomic< uint8 >& InState,
FAcquireLock
)

 Construct in a locked state. Avoids an expensive compare-and-swap at creation time.

Functions

  Type Name Description
Public function Const bool  
Public function void

Lock ()

  
Public function bool

TryLock ()

  
Public function void

Unlock ()

  

Operators

  Type Name Description
Public function FExternalMutex &  

Constants

Name Description
HasWaitingThreadsFlag  
IsLockedFlag  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page