Table Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The Table type exposes the following members.

Constructors

	Name	Description
	Table	Initializes a new instance of the Table class

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Get	Retrieves an item from this table by key where item age is less or equal to requested, or null if it does not exist
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetOrPut TContext	Retrieves an item from this table by key where item age is less or equal to requested, or calls the itemFactory function and inserts the value in the store
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Put(UInt64, Object, Int32, Int32, Nullable DateTime )	Puts a key-identified item into this table. If item with such key is already in this table then replaces it and returns false, returns true otherwise
	Put(UInt64, Object, CacheRec , Int32, Int32, Nullable DateTime )	Puts a key-identified item into this table. If item with such key is already in this table then replaces it and returns false, returns true otherwise
	Remove	Removes a key-identified item from the named table returning true when item was deleted or false when item was not found
	Sweep
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	BUCKET_COUNT_DEFAULT
	MAX_AGE_SEC_DEFAULT
	MAX_AGE_SEC_MINIMUM
	REC_PER_PAGE_DEFAULT
	stat_ComplexHitCount	how many complex key hits - get was called
	stat_ComplexMissCount	how many complex key misses - get was called
	stat_HitCount	how many hits - get was called
	stat_LastTime
	stat_MissCount	how many misses - get was called
	stat_PutCollisionCount	how many times new value overrode existing because of collision
	stat_PutCount	how many times put was called
	stat_PutInsertCount	how many times new value successfully inserted without collision
	stat_PutPageCreateCount	how many times bucket collision occured that resulted in page creation
	stat_PutPriorityPreventedCollisionCount	how many times priority prevented collision
	stat_PutReplaceCount	how many times new value successfully replaced existing one (by the same key) without collision
	stat_RemoveHitCount	how many records have been found and removed
	stat_RemoveMissCount	how many records have been sought to be removed but were not found
	stat_RemovePageCount	how many pages have been deleted, a page gets deleted when there are no records stored in it
	stat_SweepPageCount	how many pages swept
	stat_SweepRemoveCount	how many records removed by sweep
	stat_SweepTableCount	how many times swept
	stat_ValueFactoryCount	how many times factory called from GetOrPut

Properties

	Name	Description
	BucketCount	Returns how many slots/buckets are pre-allocated per table, the higher the number the more memory will be reserved at table construction time, every slot is a reference (4 bytes on 32bit systems, 8 bytes on 64bit). For optimal performance this number should be around 75% of total record count stored in the table (table load factor).
	BucketPageLoadFactor	Returns the ratio of how many buckets are loaded with pages vs. bucket count
	Capacity	Returns the maximum number of items that this table can hold at any given time given that no items will have any key hash collisions
	Count	Returns item count in the table
	LockCount	Returns how many locks can be used for thread coordination during table changes
	MaxAgeSec	Gets/sets maximum age of items in the table expressed in seconds. After this age is exceeded, the system will delete entries. The system does not guarantee that items will expire right on time, however it does guarantee that items will be available for at least this long.
	Name	Returns table name which is a unique string within the cache store
	PageCount	Returns page count in the table
	ParallelSweep	When enabled, uses parallel execution while sweeping table buckets, otherwise sweeps sequentially (default behavior)
	RecPerPage	Returns how many slots are pre-allocated per table's bucket(page) when more than one item produces hash collision. The higher the number, the more primary hash collisions can be accomodated by re-hashing on pages (secondary hash table within primary buckets)
	StatComplexHitCount	Returns hit count stats for using complex keys
	StatComplexMissCount	Returns miss count stats for using complex keys
	StatHitCount	Returns hit count stats
	StatMissCount	Returns miss count stats
	Store	Returns the store instance that this table is a part of