Version: 2019.2
LanguageEnglish
  • C#

DisposeSentinel

class 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

DisposeSentinel is used to automatically detect memory leaks.

The DisposeSentinel class is used by native containers to automatically track memory leaks, and report them to the user. The DisposeSentinel is a managed object that is only referenced by the native container that holds the native data that we don't want to leak. The DisposeSentinel finalizer, which is invoked when there are not more references to the native container that owns it, checks if the referenced data has been disposed correctly or not, and in case it is not, it logs an error containing the information about when the initial allocation happened.

The DisposeSentinel class is available only when ENABLE_UNITY_COLLECTIONS_CHECKS is defined.

See Also: the example in NativeContainerAttribute.

Static Methods

ClearClears the DisposeSentinel.
CreateCreates a new AtomicSafetyHandle and a new DisposeSentinel, to be used to track safety and leaks on some native data.
DisposeReleases the AtomicSafetyHandle and clears the DisposeSentinel.

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