class Disposable in Tinman.Core.System

Abstract implementation of the IDisposable interface.

abstract class	Disposable	implements	IDisposable
		base of	ApplicationBase
			ApplicationLoop
			ApplicationWindowBase
			Bitmap
			BlockIndexBase
			BlockStorage
			ByteBuffer
			Canvas
			CanvasContent
			CanvasFactory
			Component
			CsvReader
			CsvWriter
			DataCache
			DatasetCollection
			DatasetFileCache
			DataStreamBase
			DirectX9RenderTarget
			Disposer
			EnvironmentMapResource
			Event
			FileBase
			FileSystem
			GeometryBuffer
			Grammar
			GrammarBuilder
			Graph
			Graphics
			Heightmap
			HeightmapGrinder
			HeightmapPainter
			HeightmapProjector
			ImageReaderBase
			ImageSampler
			ImageWriter
			IndexBufferBase
			Initializable
			MeshBuffer
			MeshOptions
			ModelGeometryBuffer
			ModelReaderBase
			Monitor
			ObjectPoolBase
			Operation
			ParserContext
			PixelFont
			ProgressMonitor
			Pyramid
			PyramidFileCache
			Renderer
			ResourceCache
			ResourceLoader
			RingBuffer
			RunningOperation
			ScreenQuad
			SerializableDisposableBase
			ShaderEffect
			ShaderEffectCompileInfo
			ShaderTechnique
			ShadowMappingResource
			ShapeReader
			SimpleHttp
			Sky
			SourceCodeWriter
			TaskGroup
			TaskPool
			TerrainBuffer
			TerrainBufferResource
			TerrainLayer
			TerrainMesh
			TerrainView
			TexelBuffer
			TextStreamBase
			Texture2D
			TextureAtlas
			TextureCube
			TextureData2D
			Thread
			ThreadMainBase
			VertexBufferBase
			VertexBufferCache
			VertexUpdater

Remarks

An IDisposable object can hold references to the following types of resources:

• Managed: References to objects/arrays that are handled by the garbage collector resp. by smart pointers. The referenced objects will continue to exist when referencing object is disposed (i.e. they will not be disposed since they only represent associations).
  These references should be cleared in DisposeManaged.
• Unmanaged: References to system resources that are not handled by the garbage collector resp. smart pointers. This typically includes system handles and raw memory allocations.
  These references should be cleared in DisposeUnmanaged.

The order in which the DisposeManaged and DisposeUnmanaged methods are called when an Disposable object is disposed via the Dispose method is the following:

1. DisposeManaged
2. DisposeUnmanaged

When an Disposable object is garbage collected resp. deleted because the reference counter has dropped to zero, it will be disposed automatically. In this case, only the DisposeUnmanaged method will be called.

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
implements	ILifecycleState.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
implements	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
implements	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected virtual method

DisposeManaged ()

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method

DisposeUnmanaged ()

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.

Logging

Logger

The logger object of this class.

public static readonly field	Logger
type	ILogger