Inheritance diagram for erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >:

Collaboration diagram for erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >:

Public Member Functions
	IndexedRDList (Func< List< T >> retrieveFunc, Func< T, TK > indexFunc, Caching caching)

bool	Contains (T element)

bool	ContainsGuid (Guid guid)

bool	ContainsName (string name)

virtual T	GetByGuid (Guid guid)

virtual T	GetByName (string name)

new IIndexedRDList< TK, T >	Refreshed ()

virtual bool	TryGetByGuid (Guid guid, out T output)

virtual bool	TryGetByName (string name, out T output)

void	WaitFor (Func< IIndexedRDList< TK, T >, bool > predicate, TimeSpan maxWait, TimeSpan retryPeriod)

void	WaitFor (Predicate< IRDList< T >> predicate, TimeSpan maxWait, TimeSpan retryPeriod)

Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IndexedCachedList< TK, T >
	IndexedCachedList (Func< List< T >> retrieveFunc, Func< T, TK > indexFunc, Caching caching)

bool	ContainsKey (TK key)

T	Get (TK key)

new IIndexedCachedList< TK, T >	Refreshed ()

bool	TryGet (TK key, out T obj)

void	WaitFor (Predicate< IIndexedCachedList< TK, T >> predicate, TimeSpan maxWait, TimeSpan retryPeriod)

Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.CachedList< T >
	CachedList (Func< List< T >> retrieveFunc, Caching caching)

T	GetByPosition (int pos)

IEnumerator< T >	GetEnumerator ()

virtual void	InvalidateCache ()

void	Refresh ()

ICachedList< T >	Refreshed ()

void	WaitFor (Predicate< ICachedList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)

Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.ICachedList< out T >
T	GetByPosition (int pos)
	Get an element of the list at a specific position.

ICachedList< T >	Refreshed ()
	Calls Refresh() and returns this.

void	WaitFor (Predicate< ICachedList< T >> predicate, TimeSpan wait, TimeSpan retryPeriod)
	Waits until a predicate on itself becomes true. Every retry period Refresh() is called and the predicate evaluated again, until the predicate evaluates to true, or the wait timespan is exhausted.

Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.ICached
void	InvalidateCache ()
	Clear the cache and refresh it on the next access.

void	Refresh ()
	Updates the cache immediatly.

Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IIndexedCachedList< in TK, T >
bool	ContainsKey (TK key)
	Check wether the index contains a specific key. If you want to get an element, if it is available, use TryGet as it is faster than a call to ContainsKey and a Get afterwards.

T	Get (TK key)
	Get an entry with a specific key value. Throws an exception if entry could not be found.

new IIndexedCachedList< TK, T >	Refreshed ()

bool	TryGet (TK name, out T obj)
	Try to get an entry with a specific key value, returns false, if entry could not be found.

void	WaitFor (Predicate< IIndexedCachedList< TK, T >> predicate, TimeSpan maxWait, TimeSpan retryPeriod)

Public Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IIndexedRDList< in TK, T >
new IIndexedRDList< TK, T >	Refreshed ()

void	WaitFor (Func< IIndexedRDList< TK, T >, bool > predicate, TimeSpan maxWait, TimeSpan retryEverySecond)

Protected Member Functions
	IndexedRDList (Func< T, TK > indexFunc, Caching caching)

Protected Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.IndexedCachedList< TK, T >
	IndexedCachedList (Func< T, TK > indexFunc, Caching caching)

Protected Member Functions inherited from erminas.SmartAPI.Utils.CachedCollections.CachedList< T >
	CachedList (Caching caching)

void	EnsureListIsLoaded ()

Additional Inherited Members
Properties inherited from erminas.SmartAPI.Utils.CachedCollections.IndexedCachedList< TK, T >
override bool	IsCachingEnabled `[set]`

override List< T >	List `[set]`

T	this[TK key] `[get]`

Properties inherited from erminas.SmartAPI.Utils.CachedCollections.IIndexedCachedList< in TK, T >
T	this[TK key] `[get]`
	Same as GetByName only as indexer.

Properties inherited from erminas.SmartAPI.Utils.CachedCollections.IRDList< T >
new int	Count `[get]`

Detailed Description

Type Constraints

T	:	class
T	:	IRedDotObject

Definition at line 29 of file IndexedRDList.cs.

Constructor & Destructor Documentation

erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.IndexedRDList	(	Func< List< T >>	retrieveFunc,
		Func< T, TK >	indexFunc,
		Caching	caching
	)

Definition at line 31 of file IndexedRDList.cs.

erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.IndexedRDList	(	Func< T, TK >	indexFunc,
		Caching	caching
	)

protected

Definition at line 36 of file IndexedRDList.cs.

Member Function Documentation

bool erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.Contains ( T element )

Definition at line 40 of file IndexedRDList.cs.

bool erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.ContainsGuid ( Guid guid )

Definition at line 45 of file IndexedRDList.cs.

bool erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.ContainsName ( string name )

Definition at line 51 of file IndexedRDList.cs.

virtual T erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.GetByGuid ( Guid guid )

virtual

Reimplemented in erminas.SmartAPI.Utils.CachedCollections.GuidIndexedRDList< T >.

Definition at line 57 of file IndexedRDList.cs.

virtual T erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.GetByName ( string name )

virtual

Reimplemented in erminas.SmartAPI.Utils.CachedCollections.NameIndexedRDList< T >.

Definition at line 63 of file IndexedRDList.cs.

new IIndexedRDList<TK, T> erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.Refreshed ( )

Definition at line 69 of file IndexedRDList.cs.

virtual bool erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.TryGetByGuid	(	Guid	guid,
		out T	output
	)

virtual

Reimplemented in erminas.SmartAPI.Utils.CachedCollections.GuidIndexedRDList< T >.

Definition at line 75 of file IndexedRDList.cs.

virtual bool erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.TryGetByName	(	string	name,
		out T	output
	)

virtual

Reimplemented in erminas.SmartAPI.Utils.CachedCollections.NameIndexedRDList< T >.

Definition at line 82 of file IndexedRDList.cs.

void erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.WaitFor	(	Func< IIndexedRDList< TK, T >, bool >	predicate,
		TimeSpan	maxWait,
		TimeSpan	retryPeriod
	)

Definition at line 89 of file IndexedRDList.cs.

void erminas.SmartAPI.Utils.CachedCollections.IndexedRDList< TK, T >.WaitFor	(	Predicate< IRDList< T >>	predicate,
		TimeSpan	maxWait,
		TimeSpan	retryPeriod
	)

Definition at line 94 of file IndexedRDList.cs.

The documentation for this class was generated from the following file:

IndexedRDList.cs

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation