ICacheImplementation MembersNFX Class Library

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

The ICacheImplementation type exposes the following members.
Methods

  NameDescription
Public methodCheckForCompleteStop
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from IService.)
Public methodConfigure
Configures an entity from supplied config node
(Inherited from IConfigurable.)
Public methodOnlineDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from OnlineIDisposable.)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
(Inherited from IExternallyParameterized.)
Public methodExternalParametersForGroups
Gets names of supported external parameters or null if parameters are not supported in principle
(Inherited from IExternallyParameterized.)
Public methodExternalSetParameter
Sets external parameter value, true if parameter name was found and set succeeded
(Inherited from IExternallyParameterized.)
Public methodGetOrCreateTable TKey (String, IEqualityComparer TKey )
Returns existing table by name, if it does not exist creates a new table. For existing table the types must be identical to the ones used at creation
(Inherited from ICache.)
Public methodGetOrCreateTable TKey (String, Boolean , IEqualityComparer TKey )
Returns existing table by name, if it does not exist creates a new table. For existing table the types must be identical to the ones used at creation
(Inherited from ICache.)
Public methodGetTable TKey 
Returns existing table by name, if it does not exist thorws. The TKey must correspond to existing table
(Inherited from ICache.)
Public methodPurgeAll
Removes all data from all tables stored in the cache
(Inherited from ICache.)
Public methodSignalStop
Non-blocking call that initiates the stopping of the service
(Inherited from IService.)
Public methodStart
Blocking call that starts the service instance
(Inherited from IService.)
Public methodWaitForCompleteStop
Blocks execution of current thread until this service has completely stopped
(Inherited from IService.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodDeleteThrough TKey  (Defined by CacheExtensions.)
Public Extension MethodFetchFrom TKey, TResult 
Fetches an existing item from cache or null. IsAbsent is true when data was read from cache as an AbsentValue
(Defined by CacheExtensions.)
Public Extension MethodFetchThrough TKey, TResult 
Fetches an item through cache
(Defined by CacheExtensions.)
Public Extension MethodSaveThrough TKey, TData  (Defined by CacheExtensions.)
Back to Top
Properties

  NameDescription
Public propertyComponentCommonName
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations. This name is searched-by some management tools that allow to find component by this name that does not change between application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from IApplicationComponent.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from IApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from IApplicationComponent.)
Public propertyCount
Returns how many records are kept in cache
(Inherited from ICache.)
Public propertyDefaultTableOptions
Sets default options for a table which is not found in TableOptions collection. If this property is null then every table assumes the set of constant values defined in Table class
Public propertyExternalParameters
Gets names/types of supported external parameters or null if parameters are not supported in principle
(Inherited from IExternallyParameterized.)
Public propertyInstrumentationEnabled
Turns on/off instrumentation
(Inherited from IInstrumentable.)
Public propertyLocality
Returns whether the cache key:value mappings are local or distributed
(Inherited from ICache.)
Public propertyName (Inherited from INamed.)
Public propertyPersistence
Returns the model of key:value mapping persistence that this cache supports
(Inherited from ICache.)
Public propertyPileAllocMode
Defines modes of allocation: space/time tradeoff
Public propertyPileMaxMemoryLimit
Imposes a limit on maximum number of bytes that a pile can allocate of the system heap. The default value of 0 means no limit, meaning - the pile will keep allocating objects until the system allows. If the limit is reached, then the cache will start deleting older objects to releave the memory load even if they are not due for expiration yet
Public propertyPileStatus
Returns the status of the pile where object are stored
(Inherited from ICache.)
Public propertyRunning
Returns true when service is active or about to become active. Check in service implementation loops/threads/tasks
(Inherited from IService.)
Public propertyStatus
Current service status
(Inherited from IService.)
Public propertyTableOptions
Returns table options - used for table creation
Public propertyTables
Tables that this cache contains
(Inherited from ICache.)
Back to Top
See Also