ExpiringList(T) Class

ExpiringListT Class

Manages a self-expiring list of items.

Inheritance Hierarchy

SystemObject
VirtualRadar.InterfaceExpiringCollectionT
VirtualRadar.InterfaceExpiringListT

Namespace: VirtualRadar.Interface
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public class ExpiringList<T> : ExpiringCollection<T>
where T : class

Public Class ExpiringList(Of T As Class)
	Inherits ExpiringCollection(Of T)

generic<typename T>
where T : ref class
public ref class ExpiringList : public ExpiringCollection<T>

type ExpiringList<'T when 'T : not struct> =  
    class
        inherit ExpiringCollection<'T>
    end

Type Parameters

T

The ExpiringListT type exposes the following members.

Constructors

	Name	Description
	ExpiringListT	Creates a new object.

Top

Properties

	Name	Description
	AfterCheckForExpiredItemsDelegate	Gets or sets an optional delegate that is called after the check for expired items is made. (Inherited from ExpiringCollectionTItem.)
	BeforeCheckForExpiredItemsDelegate	Gets or sets an optional delegate that is called before the check is made for expired items. (Inherited from ExpiringCollectionTItem.)
	Count	Gets the current count of items in the list. (Overrides ExpiringCollectionTItemCount.)
	CountChangedDelegate	Gets or sets an optional delegate that is called when the count changes. The new count is passed to the delegate. The list is locked to the calling thread while the delegate is running. The delegate will occasionally be called on a background thread. (Inherited from ExpiringCollectionTItem.)
	ExpireMilliseconds	Gets or sets the minimum number of milliseconds that an item can remain within the list. (Inherited from ExpiringCollectionTItem.)
	MillisecondsBetweenChecks	Gets or sets the minimum number of milliseconds to wait between checks for expiring items. (Inherited from ExpiringCollectionTItem.)

Top

Methods

	Name	Description
	Add	Adds the item to the list.
	AddOrRefresh	Adds the item if it is not already in the list. If it is in the list then its timestamp is refreshed to the current time.
	AddRange	Adds a range of items to the list.
	AddRangeOrRefresh	Adds a range of items to the list. Items that already exist in the list have their timestamps refreshed.
	ChangeIntervals	Changes the intervals for the expiration of items and the interval between checks. (Inherited from ExpiringCollectionTItem.)
	Clear	Empties the list. (Overrides ExpiringCollectionTItemClear.)
	Dispose	See interface docs. (Inherited from ExpiringCollectionTItem.)
	Dispose(Boolean)	Disposes of or finalises the object. (Inherited from ExpiringCollectionTItem.)
	DoRemoveExpiredItems	See base docs. (Overrides ExpiringCollectionTItemDoRemoveExpiredItems(DateTime).)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Finalises the object. (Inherited from ExpiringCollectionTItem.)
	Find	Returns the item that matches the predicate or null if no such item exists.
	FindAll	Returns all of the items that match the predicate or an empty list if no such items exist.
	FindAllAndRefresh	Returns all of the items that match the predicate or an empty list if no such items exist. Refreshes the timestamps for all of the items returned.
	FindAndRefresh	Returns the item that matches the predicate or null if no such item exists. Refreshes the timestamp for the item.
	FindCollectionItem	Finds the collection item for the item passed across.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HookHeartbeat	Hooks the heartbeat event. Must be called from within a lock. (Inherited from ExpiringCollectionTItem.)
	Lock	Calls the action passed across with the list locked. Do not perform an action that will attempt to lock the list from another thread, it will block. (Inherited from ExpiringCollectionTItem.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCountChanged	Called by the derivee to inform the owner of the collection that the count has changed. Always call this from within a lock. (Inherited from ExpiringCollectionTItem.)
	RefreshAll	Refreshes the timestamps on every item in the list.
	Remove	Removes the item from the list.
	RemoveExpiredItems	Removes expired items. (Inherited from ExpiringCollectionTItem.)
	RemoveRange	Removes a range of items from the list.
	Snapshot	Returns a clone of the contents of the list.
	SnapshotAndRefresh	Returns a clone of every item in the list. Refreshes the timestamps on every item.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnhookHeartbeat	Unhooks the heartbeat service if hooked. Must be called from within a lock. (Inherited from ExpiringCollectionTItem.)

Top

Fields

	Name	Description
	_Clock	The clock that provides timestamps. (Inherited from ExpiringCollectionTItem.)
	_SyncLock	The lock object that controls access to the other fields. (Inherited from ExpiringCollectionTItem.)

Top

Remarks

When an item is added to this list it is given a timestamp. The items in the list are periodically checked, if they have been in the list for longer than ExpireMilliseconds then they are removed. This class is thread-safe.

Reference

VirtualRadar.Interface Namespace