InterprocessCache Class

Represents a serialized data cache that can be saved or read from multiple applications using inter-process synchronization.

Inheritance Hierarchy

SystemObject
  GSF.IOInterprocessCache
    GSF.SecurityAdoSecurityCache
    GSF.SecurityUserDataCache
    GSF.SecurityUserRoleCache

Namespace: GSF.IO
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public class InterprocessCache : IDisposable

Public Class InterprocessCache
	Implements IDisposable

public ref class InterprocessCache : IDisposable

type InterprocessCache = 
    class
        interface IDisposable
    end

GSF.IO.InterprocessCache = function();

Type.createClass(
	'GSF.IO.InterprocessCache',
	null,
	IDisposable);

View Source

The InterprocessCache type exposes the following members.

Constructors

	Name	Description
	InterprocessCache	Creates a new instance of the InterprocessCache.
	InterprocessCache(Int32)	Creates a new instance of the InterprocessCache with the specified number of maximumConcurrentLocks.

Top

Properties

	Name	Description
	AutoSave	Gets or sets flag that determines if InterprocessCache should automatically initiate a save when FileData has been updated.
	FileData	Gets or sets file data for the cache to be saved or that has been loaded.
	FileName	Path and file name for the cache needing inter-process synchronization.
	MaximumConcurrentLocks	Gets the maximum concurrent reader locks allowed.
	MaximumRetryAttempts	Maximum retry attempts allowed for loading or saving cache file data.
	ReloadOnChange	Gets or sets flag that enables system to monitor for changes in FileName and automatically reload FileData.
	RetryDelayInterval	Wait interval, in milliseconds, before retrying load or save of cache file data.

Top

Methods

	Name	Description
	Dispose	Releases all the resources used by the InterprocessCache object.
	Dispose(Boolean)	Releases the unmanaged resources used by the InterprocessCache object and optionally releases the managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the InterprocessCache object is reclaimed by GC. (Overrides ObjectFinalize)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Load	Initiates inter-process synchronized cache file load.
	LoadFileData	Handles deserialization of file from disk; virtual method allows customization (e.g., pre-load decryption and/or data merge).
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	Save	Initiates inter-process synchronized cache file save.
	SaveFileData	Handles serialization of file to disk; virtual method allows customization (e.g., pre-save encryption and/or data merge).
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WaitForLoad	Blocks current thread and waits for any pending load to complete; wait time is RetryDelayInterval * MaximumRetryAttempts.
	WaitForLoad(Int32)	Blocks current thread and waits for specified millisecondsTimeout for any pending load to complete.
	WaitForSave	Blocks current thread and waits for any pending save to complete; wait time is RetryDelayInterval * MaximumRetryAttempts.
	WaitForSave(Int32)	Blocks current thread and waits for specified millisecondsTimeout for any pending save to complete.

Top

Fields

	Name	Description
	DefaultMaximumRetryAttempts	Default maximum retry attempts allowed for loading InterprocessCache.
	DefaultRetryDelayInterval	Default wait interval, in milliseconds, before retrying load of InterprocessCache.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

Note that all file data in this class gets serialized to and from memory, as such, the design intention for this class is for use with smaller data sets such as serialized lists or dictionaries that need inter-process synchronized loading and saving.

Reference

GSF.IO Namespace