StateServer Cached Data

Soss.Client Namespace

Provides support for accessing the ScaleOut State Server from a client application.

Namespace hierarchy

Classes

Class Description
CacheAccessNotLicensedException An exception that is thrown when an application uses the CachedDataAccessor in a manner that is not permitted by the user's license with ScaleOut Software.
CachedDataAccessor Provides access to an object that can be shared globally across multiple clients.
CachedDataAccessorException Base exception class for the CachedDataAccessor module.
CachedObjectAlreadyExistsException An exception that is thrown when an object that already exists is added to the cache.
CachedObjectLockedException An exception that is thrown when an CachedDataAccessor operation is attempted on an object that is locked by another client or another instance of the CachedDataAccessor.
CachedObjectNotFoundException An exception that is thrown when an operation is performed on an object that does not exist in the cache.
CachedObjectNotLockedException An exception that is thrown during an Update or Remove operation when the CachedDataAccessor does not have a lock on the cached object.
CachedObjExpiredEventArgs An EventArgs subclass that contains information specific to event handlers handling cached object expiration events.
ExtendedObjectMetadata ExtendedObjectMetadata augments the user-specified ObjectMetadata values with aditional read-only values maintained automatically by the State Server.
FilterCollection An IFilter implementation that may be used as the filter parameter in Query methods to select the objects to be returned.
IndexCollection A collection of IndexValues which may be used to query the State Server object store for the set of objects with metadata matching the (positional) values specified in the IndexCollection.
IndexValue An immutable value that may be assigned to an IndexCollection and used to query the StateServer for objects with metadata matching the IndexCollection.
ObjectMetadata Metadata describing a StateServer object including the set of user-defined index values defined for the object.
QueryResult Represents the result of a Query operation. In particular, a QueryResult holds a collection of StateServerKey values identifying the objects satisfying a given query.
StateServerKeyList A strongly-typed, read-only list of StateServerKey values.
StateServerUnavailableException An exception that is thrown when an unexpected error occurs while accessing ScaleOut StateServer.

Interfaces

Interface Description
IFilter Interface for filters used by StateServer Query and Invoke operations.

Structures

Structure Description
StateServerKey An immutable value type that holds a representation for the identity of an object on StateServer.

Delegates

Delegate Description
CachedObjExpiredEventHandler Delegate used by the CachedObjectExpired event.

Enumerations

Enumeration Description
CachedObjectDisposition An enumeration used to indicate to the cache whether to save or remove an object upon return from a CachedObjExpired event handler.
CachedObjectEventCode An enumeration containing the event codes providing the reason an event was fired.
CachedObjectPriority Indicates the priority of keeping an object in the cache. Currently, only two priorities are defined, NotRemovable and Normal. Removable objects are removed from memory when memory runs low based on a least recently used algorithm.
MatchOptions Options that determine whether all values in a FilterCollection must match an object's metadata to be considered a match in a Query operation or whether any matching values constitutes a match for the Query operation.
PutResult