Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

AtomicSafetyHandle

struct in Unity.Collections.LowLevel.Unsafe

/

Implemented in:UnityEngine.CoreModule

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

Description

AtomicSafetyHandle is used by the job system to provide validation and full safety.

It becomes available by defining the ENABLE_UNITY_COLLECTIONS_CHECKS symbol.

See Also: the example in NativeContainerAttribute.

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.
CheckGetSecondaryDataPointerAndThrowCheckGetSecondaryDataPointerAndThrow.
CheckReadAndThrowChecks if the handle can be read from. Throws an exception if already destroyed or a job is currently writing to the data.
CheckWriteAndBumpSecondaryVersionPerforms CheckWriteAndThrow and then 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 that is valid until AtomicSafetyHandle.Release is called.
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.
GetReaderArrayFetch the job handles of all jobs reading from the safety handle.
GetReaderNameReturn the name of the specified reading job.
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.
ReleaseReleases a previously created AtomicSafetyHandle.
SetAllowReadOrWriteAccessLets you prevent read or write access on the atomic safety handle.
SetAllowSecondaryVersionWritingSwitches the AtomicSafetyHandle to the secondary version number.
UseSecondaryVersionSwitches the AtomicSafetyHandle to the secondary version number.

Did you find this page useful? Please give it a rating:

Copyright © 2020 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961