State Server Access Library

Soss.Client Namespace

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

Namespace hierarchy

Classes

Class Description
ApplicationNamespace Represents a named collection of objects within a StateServer store.
CreateInfo An object supplying extended parameter information to Create or Create. This object allows you to specify the StateServer object timeout, the type of timeout, whether the object may be removed from memory if memory availability becomes constrained, and any dependence this object has on other StateServer objects.
DataAccessor A StateServer accessor class providing Create, Read, Update, and Delete operations to the StateServer object whose key was specified when the DataAccessor instance was created.
DataAccessorFactory Factory class for creating DataAccessor objects.
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.
LocalServiceUnavailableException A StateServerException specialization that indicates that a DataAccessor call failed because the client was unable to open a handle to the local StateServer.
NotLicensedException A StateServerException specialization that indicates that a client cannot access State Server because the client is not licensed.
NotReadyException A StateServerException specialization that indicates that the server is not yet ready to perform a particular function. Normally, this exception is detected by client API software and the operation is subsequently retried.
ObjectExistsException A StateServerException specialization that indicates that a Create call failed because an object already exists in the StateServer with the given key.
ObjectExpiredEventArgs A StateServerEventArgs subclass containing information specific to event handlers handling object or session expiration events.
ObjectLockedException A StateServerException specialization that indicates that the requested StateServer object was locked and couldn't be accessed.
ObjectMetadata Metadata describing a StateServer object including the set of user-defined index values defined for the object.
ObjectNotFoundException A StateServerException specialization that indicates that an error occurred because the key of an object on which StateServer was asked to operate was not found.
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.
ReadThroughPendingException A StateServerException specialization that indicates that an error occurred because the key of an object on which StateServer was asked to operate is not found, but a read-through operation is currently being performed by another client to create this object in the StateServer from a backing store (such as a database).
ReadThroughTimeoutException A StateServerException specialization indicating that a read-through operation to a backing store (such as a database) timed out.
SessionAccessor A DataAccessor specialization that provides StateServer access to ASP.Net session objects.
SessionExpiredEventArgs An ObjectExpiredEventArgs subclass containing information specific to session expiration.
StateServerEventArgs The base class for all StateServer EventArgs classes.
StateServerException An exception thrown when an unexpected error occurs while accessing the state server.
StateServerKeyList A strongly-typed, read-only list of StateServerKey values.
TimeoutException A StateServerException specialization that indicates that the server is not yet ready to perform a particular function. Normally, this exception is detected by client API software and the operation is subsequently retried.

Interfaces

Interface Description
IFilter Interface for filters used by StateServer Query and Invoke operations.
ISessionDictionary An emulation of the session dictionary session dictionary portion of HttpSessionState.

Structures

Structure Description
ReadMetadataResult A struct containing both a StateServerResult status value indicating the success/failure mode of a ReadMetadata operation and any metadata read from the StateServer.
ReadResult A struct containing both a StateServerResult status value indicating the success/failure mode of a Read operation and any bytes read from the StateServer.
StateServerKey An immutable value type that holds a representation for the identity of an object on StateServer.

Delegates

Delegate Description
ObjectExpiredEventHandler A delegate describing the signature of a ObjectExpired event handler.
SessionExpiredEventHandler A delegate describing the signature of a SessionExpired event handler.

Enumerations

Enumeration Description
BackingStoreAsyncPolicy Indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
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.
ObjectDisposition An enumeration used to indicate to StateServer the disposition of an expired object upon return from a StateServer event handler.
ObjectPreemptionPriority Indicates the priority of keeping a given object in StateServer memory. 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.
ReadOptions Specifies flags that control the operation of the Read method.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

StateServerEventCode An enumeration containing the event codes provided to StateServer event handlers describing the event that StateServer is reporting.
StateServerResult Result codes returned by Read and AcquireOrUpdateLock to disambiguate failures without throwing exceptions.
StatusCodes Status code values returned by the StateServer runtime.