Provides support for accessing the ScaleOut StateServer from a client application.


Classes

  Class Description
Public class BackingStorePolicy Contains options to control how a named cache interacts with a backing store. A BackingStorePolicy is associated with a NamedCache and IBackingStore instance though a call to SetBackingStoreAdapter.
Public class BulkAddException A StateServerException specialization that indicates that one or more failures occured during a bulk Add operation.
Public class CachedObjectId The CachedObjectId class serves as an identifier for a cached object in a NamedCache collection. This class cannot be inherited.
Public class CacheFactory Provides access to a collection of cached objects that is identified by a provided cache name. The GetCache method must be used to instantiate a NamedCache collection.
Public class CreatePolicy The CreatePolicy class provides extended parameter information to the Insert method and DefaultCreatePolicy property. This class 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 dependencies this object has on other StateServer objects.
Public class EvalArgs A helper object which may optionally be sent to a method invoked via Invoke when the method is executed. This class cannot be inherited.
Public class ExtendedObjectMetadata ExtendedObjectMetadata augments the user-specified ObjectMetadata values with aditional read-only values maintained automatically by the State Server.
Public class FilterCollection An IFilter implementation that may be used as the filter parameter in Query methods to select the objects to be returned.
Public class 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.
Public class IndexValue An immutable value that may be assigned to an IndexCollection and used to query the StateServer for objects with metadata matching the IndexCollection.
Public class LocalServiceUnavailableException A StateServerException specialization that indicates that a DataAccessor call failed because the client was unable to open a handle to the local StateServer.
Public class MethodInvocationException An exception thrown when a NamedCache.Invoke operation fails while performing the user-defined method or merge operation on some host.
Public class NamedCache Provides access to a named collection of objects that can be shared globally across multiple clients.
NestedFamily class NamedCache.NamedCacheDataAccessor A derived DataAccessor used to access objects within a NamedCache.
NestedFamily class NamedCache.SerializationCallbackHolder A holder for a pair of callback methods for serializing and deserializing objects written to StateServer. We hold them in a separate class to ensure they get updated and referenced atomically.
Public class NamedCacheCreatedEventArgs Provides the newly-registered cache for the NamedCacheCreated event.
Public class NamedCacheObjExpiredEventArgs An EventArgs subclass that contains information specific to event handlers handling cached object expiration events.
Public class NotLicensedException A StateServerException specialization that indicates that a client cannot access State Server because the client is not licensed.
Public class ObjectExistsException A StateServerException specialization that indicates that a Create call failed because an object already exists in the StateServer with the given key.
Public class ObjectLockedException A StateServerException specialization that indicates that the requested StateServer object was locked and couldn't be accessed.
Public class ObjectMetadata Metadata describing a StateServer object including the set of user-defined index values defined for the object.
Public class 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.
Public class 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.
Public class ReadThroughTimeoutException A StateServerException specialization indicating that a read-through operation to a backing store (such as a database) timed out.
Public class SossObjDescriptor Contains information neccessary to insert an object into a NamedCache via a bulk Add operation.
Public class StateServerException An exception thrown when an unexpected error occurs while accessing the state server.
Public class StateServerKeyList A strongly-typed, read-only list of StateServerKey values.

Interfaces

  Interface Description
Public interface IBackingStore Provides a means for a named cache to interact with a backing store (such as a database) to perform read-through, write-though, refresh-ahead, and write-behind operations.
Public interface IFilter Interface for filters used by StateServer Query and Invoke operations.

Structures

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

Delegates

  Delegate Description
Public delegate Deserializer A delegate to a method that can deserialize an object previously serialized with Serializer from the supplied stream.
NestedPublic delegate NamedCache.ObjectExpiredEventHandler Delegate used by the ObjectExpired event.
Public delegate NamedCacheCreatedEventHandler The signature required of methods that handle the NamedCacheCreated event.
Public delegate Serializer A delegate to a method that can serialize an object into a Stream.

Enumerations

  Enumeration Description
Public enumeration BackingStoreAsyncPolicy Indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
Public enumeration EvalObjectDisposition Specifies the desired disposition of the target object following execution of an eval method.
Public enumeration 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.
Public enumeration NamedCacheEventCode An enumeration containing the event codes providing the reason an event was fired.
Public enumeration NamedCacheObjDisposition An enumeration used to indicate to the cache whether to save or remove an object upon return from a ObjectExpired event handler.
Public enumeration 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.
Public enumeration StatusCodes Status code values returned by the StateServer runtime.

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.