Version: 2023.1
LanguageEnglish
  • C#

AtomicSafetyHandle.IsHandleValid

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static bool IsHandleValid(ref Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle);

Parameters

handle Safety handle.

Returns

bool true if the AtomicSafetyHandle is still valid, false otherwise.

Description

Check if the AtomicSafetyHandle is still valid.

An AtomicSafetyHandle becomes invalid when the version number it stores no longer matches the version number of the associated entry in the safety system. This always happens when AtomicSafetyHandle.Release has been called on this handle, or on one of the other handles referencing the same memory region. It can also happen if this handle is using the secondary version and some handle has called AtomicSafetyHandle.CheckWriteAndBumpSecondaryVersion or AtomicSafetyHandle.SetBumpSecondaryVersionOnSchedule.

For more information about container version numbers, see Copying NativeContainer structures.