UE::ParkingLot::Wait

Navigation

API > API/Runtime > API/Runtime/Core

Description

Queue the calling thread to wait if CanWait returns true. BeforeWait is only called if CanWait returns true.

CanWait is called while the queue for the address is locked. It is invalid to call into any ParkingLot function from within a CanWait function. No other thread can wake or start waiting on this address while within CanWait. Returning false from CanWait will return from Wait without waiting.

BeforeWait is called only when CanWait returns true. It is called after the queue for the address has been unlocked. It is invalid to call into any ParkingLot wait function from within BeforeWait, but it is safe to call into any wake function and may be necessary as part of the implementation of some synchronization primitives.

namespace UE  
{  
    namespace ParkingLot  
    {  
        FWaitState UE::ParkingLot::Wait  
        (  
            const void * Address,  
            TFunctionWithContext < bool> CanWait,  
            TFunctionWithContext < void> BeforeWait  
        )  
    }  
}  
Copy full snippet

namespace UE {     namespace ParkingLot     {         FWaitState UE::ParkingLot::Wait         (             const void * Address,             TFunctionWithContext < bool> CanWait,             TFunctionWithContext < void> BeforeWait         )     } }

Parameters