class BlockIndexBase in Tinman.Core.Database

abstract class	BlockIndexBase	extends	Disposable
		implements	ICanReadWrite
			IPathInfo
		base of	BlockIndex

Public / Attributes

CanRead

Does this object support read access?

public property	CanRead { get }
type	bool
value		true if this object supports reading, false if not.
implements	ICanReadWrite.CanRead

CanWrite

Does this binary object support write access?

public property	CanWrite { get }
type	bool
value		true if this object supports writing, false if not.
implements	ICanReadWrite.CanWrite

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

PathInfo

Returns a Path object that represents the file path this object is associated with.

public property	PathInfo { get }
type	Path
value	[not-null]	The path info.
implements	IPathInfo.PathInfo

Remarks:

Objects that do not have a meaningful file path association simply return Unknown.

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.
inherited	Disposable.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.

Clear

Clears all data from this block index.

[BeginWriteEnd]
public abstract method	Clear ()

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 ()
inherited	Disposable.Dispose

Remarks:

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

Protected / Attributes

pool

The pool for data streams (block node I/O).

[Owner]
protected field	pool
type	ObjectPool<MemoryDataStream>

Protected / Constructors

BlockIndexBase

Creates a new instance of BlockIndexBase.

protected constructor	BlockIndexBase (BlockStorage storage)
params	storage		The block storage.

Protected / Methods

DisposeManaged

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

protected override method	DisposeManaged ()
overrides	Disposable.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 ()
inherited	Disposable.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.