Version: 2022.3
  • C#


struct in Unity.Collections.LowLevel.Unsafe


Implemented in:UnityEngine.CoreModule

Suggest a change


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.


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.




AtomicSafetyHandle is used by the job system to coordinate access to container memory from multiple jobs safely.

You typically do not need to use this type in your code unless you are implementing your own NativeContainer type. For a conceptual overview of AtomicSafetyHandle and the role it plays in the job system, see Implement a custom native container.

Static Methods

CheckDeallocateAndThrowChecks if the handle can be deallocated. Throws an exception if it has already been destroyed or a job is currently accessing the data.
CheckExistsAndThrowChecks if the handle is still valid and throws an exception if it is already destroyed.
CheckGetSecondaryDataPointerAndThrowCheck if the data pointer is in a valid state to be aliased by a view on the container which will use the secondary version number.
CheckReadAndThrowChecks if the handle can be read from. Throws an exception if already destroyed or a job is currently writing to the data.
CheckWriteAndBumpSecondaryVersionPerforms AtomicSafetyHandle.CheckWriteAndThrow and then, assuming that the handle can be written to, bumps the secondary version.
CheckWriteAndThrowChecks if the handle can be written to. Throws an exception if already destroyed or a job is currently reading or writing to the data.
CreateCreates a new AtomicSafetyHandle.
EnforceAllBufferJobsHaveCompletedWaits for all jobs running against this AtomicSafetyHandle to complete.
EnforceAllBufferJobsHaveCompletedAndDisableReadWriteWaits for all jobs running against this AtomicSafetyHandle to complete and then disables the read and write access on this atomic safety handle.
EnforceAllBufferJobsHaveCompletedAndReleaseWaits for all jobs running against this AtomicSafetyHandle to complete and then releases the atomic safety handle.
GetAllowReadOrWriteAccessReturns true if the AtomicSafetyHandle is configured to allow reading or writing.
GetNestedContainerCheck whether the given AtomicSafetyHandle represents a nested container, and therefore cannot safely be used in jobs.
GetReaderArrayFetch the job handles of all jobs reading from the safety handle.
GetReaderNameReturn the name of the specified reading job.
GetTempMemoryHandleReturns the safety handle which should be used for all temp memory allocations in this temp memory scope.
GetTempUnsafePtrSliceHandleReturns a single shared handle, that can be shared by for example NativeSlice pointing to stack memory.
GetWriterReturn the writer (if any) on an atomic safety handle.
GetWriterNameReturn the debug name of the current writer on an atomic safety handle.
IsDefaultValueCheck if the handle still has its default value (i.e. has not yet been initialized by being assigned or passed to AtomicSafetyHandle.Create).
IsHandleValidCheck if the AtomicSafetyHandle is still valid.
IsTempMemoryHandleChecks if an AtomicSafetyHandle is the temp memory safety handle for the currently active temp memory scope.
IsValidNonDefaultHandleCheck if the handle has been initialized and is currently valid.
NewStaticSafetyIdAllocates a new static safety ID, to store information for the provided type T.
PrepareUndisposableMarks the AtomicSafetyHandle so that it cannot be disposed of.
ReleaseReleases a previously created AtomicSafetyHandle.
SetAllowReadOrWriteAccessLets you prevent read or write access on the atomic safety handle.
SetAllowSecondaryVersionWritingSet whether handles which use the secondary version number are allowed to write to the container protected by this handle.
SetBumpSecondaryVersionOnScheduleWriteLets you automatically bump the secondary version when scheduling a job that has write access to the atomic safety handle.
SetCustomErrorMessageProvide a custom error message for a specific job debugger error type, in cases where additional context can be provided.
SetNestedContainerSets or unsets the nested container flag on an AtomicSafetyHandle.
SetStaticSafetyIdAssigns the provided static safety ID to an AtomicSafetyHandle. The ID's owner type name and any custom error messages are used by the job debugger when reporting errors involving the target handle.
UseSecondaryVersionSwitches the AtomicSafetyHandle to the secondary version number.
ValidateNonDefaultHandleCheck that the handle has been initialized, and if so, check that it is still valid.