 | Memory |
Implementation of the IDataCachingService which uses the in-process memory to cache objects
Inheritance HierarchyNamespace: SanteDB.Caching.Memory
Assembly: SanteDB.Caching.Memory (in SanteDB.Caching.Memory.dll) Version: 3.0.2081-alpha+73f4bcede15fc876f30607896483d7d817ecc787
SyntaxThe MemoryCacheService type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MemoryCacheService | Creates a new memory cache service |
Properties| Name | Description | |
|---|---|---|
 | CacheName | |
| IsRunning | True when the memory cache is running |
| ServiceName | Gets the service name |
| Size | Gets the current size of the cache in objects |
Methods| Name | Description | |
|---|---|---|
| Add | Adds data to the cache |
| Clear | Purges the entire cache of all entries |
| Count | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExistsT | Determines if the object exists |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetCacheItem(Guid) | Gets the cache item specified by key regardless of the type of data |
| GetCacheItemTData(Guid) | Gets the cache item specified by key returning it as a casted instance of TData. Returning the default of TData if the object doesn't exist or if the object is the wrong type. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Remove(Guid) | Removes/evicts an object with identifier key from the cache |
| Remove(IdentifiedData) | Removes/evicts the provided object form cache if available |
| Start | Indicates the caller wishes to start the daemon service lifecycle |
| Stop | Indicates the caller wishes to stop the daemon service |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Trim |
Events| Name | Description | |
|---|---|---|
 | Added | Fired after an object has successfully been committed to the cache |
| Removed | Fired after an object has successfully been evicted from cache |
| Started | Fired when the daemon service has completed it start procedure. |
| Starting | Fired when the daemon service has commenced start but has not yet finished |
| Stopped | Fired when the daemon has completed its stop procedure |
| Stopping | Fired when the daemon service has commenced stop but has not yet been fully shut down. |
| Updated | Fired after an object has successfully been updated within the cache |
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertTReturn |
The purpose of this method is to convert object me to TReturn. Why?
Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast
so we have to copy.
(Defined by ExtensionMethods) |
| WithControl |
With control parameter is used as a wrapper for _ parameters
(Defined by QueryFilterExtensions) |
RemarksThe memory cache service uses the MemoryCache class as a backing cache for the SanteDB host instance. This caching provider provides benefits over a common, shared cache like REDIS in that:
- It does not require the setup of a third-party service to operate
- The cache objects are directly accessed and not serialized
- The cache objects are protected within the host process memory
- The access is very fast - there is no interconnection with another process
This cache service should only be used in cases when there is a single SanteDB server and there is no need for sharing cache objects between application services.
This class uses the TTL setting from the MemoryCacheConfigurationSection to determine the length of time that cache entries are valid
See Also