Provides support for accessing the ScaleOut StateServer from a client application.
Classes
Class | Description | |
---|---|---|
AsyncAcquireLockResult |
Output values returned from a AcquireOrUpdateLockAsync(Boolean, LockTicket, CancellationToken) call.
| |
AsyncGetMetadataResult | ||
AsyncPutResult |
Output values returned from a PutAsync(AsyncPutParams, Object, Byte, Int32, Int32, CancellationToken) call.
| |
AsyncReadObjectResult |
Output values returned from a ReadObjectAsync(ReadOptions, LockTicket, CancellationToken) call. In particular, the object deserialized from the
bytes read from ScaleOut StateServer is retured.
| |
AsyncReadResult |
Output values returned from a ReadAsync(ReadOptions, LockTicket, CancellationToken) call.
| |
AuthorizationNotNeededException |
A StateServerException specialization that indicates that a login was performed on a
cache that does not require authorization.
| |
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(IBackingStore, BackingStorePolicy).
| |
BulkAddException |
A StateServerException specialization that indicates that
one or more failures occurred during a bulk Add(IDictionary) operation.
| |
CachedObjectId |
The CachedObjectId class serves as an identifier for a cached object in a NamedCache collection.
| |
CachedObjectIdT |
The typed CachedObjectIdT class serves as an identifier for a cached
object in a NamedCache collection where the type of the object is known.
| |
CacheFactory |
Provides access to a collection of cached objects that is identified by a provided
cache name. The GetCache(String) method must be used to
instantiate a NamedCache collection.
| |
CreatePolicy |
The CreatePolicy class provides extended parameter information to the Insert(String, Object, CreatePolicy, Boolean, Boolean) 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.
Advanced features such as GeoServer replication policies and backing store policies can also be controlled using this class.
| |
Dependency |
Identifies an Assembly that is a dependency of an InvocationGrid.
| |
DistributedParallelExtensions |
Host class for the ForEach extension methods
which allow you to execute a method in parallel on all connected StateServer hosts and merge the results.
| |
DistributedParallelOptions |
Options for ForEach extension methods.
| |
EvalArgs |
A helper object which may optionally be passed to an evalMethod delegate invoked via
InvokeT, P, R(IFilter, P, FuncT, P, EvalArgs, R, FuncR, R, R, TimeSpan)
when the method is executed.
| |
Event |
Contains information about an event that was pushed from a ScaleOut client (via
PostEvent(CachedObjectId, String, Byte, NullableTimeSpan))
to an event source.
| |
EventDeliveryExceptionEventArgs |
Provides data about exceptions thrown from the event delivery pipeline.
| |
ExtendedObjectMetadata | ExtendedObjectMetadata augments the user-specified ObjectMetadata values with additional 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 supplied to State Server in
either query/filter operations or when specifying metadata values.
| |
IndexValue |
An immutable value that may be assigned to an IndexCollection
and used to query the StateServer for objects with metadata matching the IndexCollection.
| |
InvocationGrid |
An object that represents an ScaleOut StateServer invocation grid.
| |
InvocationGridBuilder |
An InvocationGrid factory 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.
| |
LoginManager |
Logs in to the ScaleOut StateServer service on a per-cache basis, passing
supplied credentials to the server.
| |
MethodInvocationException |
An exception thrown when a NamedCache.Invoke operation fails while performing the
user-defined method or merge operation on some host.
| |
MultipleLoginException |
A StateServerException specialization that indicates that
multiple users attempted to login to the same namespace from the same
client application.
| |
NamedCache |
Provides access to a named collection of objects that can be shared globally across multiple clients.
| |
NamedCacheAsyncNamedCacheDataAccessor |
A NamedCacheDataAccessor subclass that does not allow itself to be cached
in a thread-local cache to manage object locking behavior.
| |
NamedCacheCreatedEventArgs |
Provides the newly-registered cache for the NamedCacheCreated event.
| |
NamedCacheObjectMetadata |
The NamedCacheObjectMetadata class provides information about an object that is stored in ScaleOut StateServer, including user-specified metadata
and additional metadata that is maintained by the ScaleOut StateServer service. The class offers the same information as
the ObjectMetadata and ExtendedObjectMetadata classes, but its DefaultCoherencyPolicy
property is able to provide GeoServer "pull" replication policy information for the object.
| |
NamedCacheObjExpiredEventArgs |
An EventArgs subclass that contains information specific to event handlers handling cached object expiration events.
| |
NoActiveRemoteStoreException |
A StateServerException specialization that indicates that none of the remote stores from
the list provided to the SetRemoteStoreAccess method is active or exists.
| |
NotAuthorizedException |
A StateServerException specialization that indicates that
an operation failed in the State Server because of authorization restrictions.
| |
NotifyCoherencyPolicy |
A GeoServer coherency policy indicating that proxy objects in remote stores get notified every
time the master object is updated. There is no possibility of stale data. This is effectively a
per-object "push" replication model.
| |
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 Overload call failed because an object already exists in the StateServer with the
given key.
| |
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.
| |
OperationNotImplementedException |
A StateServerException specialization that indicates that an operation is not supported
in the current version of the ScaleOut StateServer service.
| |
OptimisticLockException |
A StateServerException specialization that indicates that
the requested StateServer object was locked and couldn't be accessed.
| |
PollingCoherencyPolicy |
A GeoServer coherency policy indicating that proxy objects in remote stores should periodically poll the
master object for updates when the specified CoherencyInterval has elapsed. This policy
optimizes network traffic. Remote reads may experience delays and local reads may return
stale data.
| |
QueryableExtensions |
A static class containing extension methods useful for extending StateServer property index queries.
| |
QueryResult |
Represents the result of a Query Overload operation. In particular,
a QueryResult holds a collection of StateServerKey values
identifying the objects satisfying a given query.
| |
ReadThroughTimeoutException |
A StateServerException specialization indicating that
a read-through operation to a backing store (such as a database)
or a remote GeoServer store has timed out.
| |
RemoteStore |
Represents a remote store to be accessed for object retrieval when
GeoServer "pull" replication has been configured.
| |
RemoteStoreAccessException |
A StateServerException specialization that indicates that an access error to a remote
store occured. This may be due to a timeout or network outage. This exception is thrown only during
synchronous remote store operations (reading an object for the first time, peforming a locking read,
or explicitly forcing a remote read).
| |
RemoteStoreCollection |
An ordered collection of unique RemoteStore objects. The collection may contain
no more than 8 items. Null items are not allowed.
| |
SossIndexAttribute |
A marker Attribute that indicates that the property or class to which it
applies should be saved in the StateServer property index when instances of the class
are created or updated.
| |
SossObjDescriptor |
Contains information necessary to insert an object into a NamedCache via a bulk Add(IDictionary) operation.
| |
SparseBitmap |
A logical dynamic array of booleans stored in a compact representation where we assume
far fewer values are set to true than are set to false.
| |
StaleDataException |
A StateServerException specialization indicating that the object or metadata that is
being read is a proxy copy of the remote master object, and the previous polling operation failed.
When this exception is caught, the stale version of the object returned from the local store can be
recovered from the StaleObject property if the exception has not been
serialized/deserialized.
| |
StateServerException |
An exception thrown when an unexpected error occurs while accessing the state server.
| |
StateServerKeyList |
A strongly-typed, read-only list of StateServerKey values.
| |
TagExtensions |
Provides a set of static methods managing Tags within the StateServer NamedCache environment.
|
Structures
Structure | Description | |
---|---|---|
GetMetadataOptions |
Struct containing options that can be used when retrieving object metadata from ScaleOut StateServer.
| |
LockTicket |
A value that identifies a lock for an object stored in ScaleOut StateServer.
| |
OptimisticConcurrencyVersion |
An object used to hold optimistic concurrency version information used by the
StateServer for objects that implement IOptimisticConcurrencyVersionHolder.
| |
RetrieveOptions |
Struct containing options that can be used when retrieving an object from ScaleOut StateServer.
| |
StateServerKey |
An immutable value type that holds a representation for the identity of an
object on StateServer.
| |
UpdateOptions |
Struct containing options that can be used when updating an object in ScaleOut StateServer.
|
Interfaces
Interface | Description | |
---|---|---|
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.
| |
ICoherencyPolicy |
Interface used by classes and structs that specify GeoServer coherency policies. This interface
supports the ScaleOut API infrastructure and is not intended to be used directly from your code.
| |
IFilter |
Interface for filters used by StateServer Query and Invoke operations.
| |
ILoginModule |
Interface for user-defined login routines. The GetEncodedCredentials(String)
method is used to generate encoded credentials which are validated by the server.
An implementation of ILoginModule can be plugged into the API by setting it via the
Login(String, ILoginModule) method.
| |
IOptimisticConcurrencyVersionHolder |
Instances of Types that implement IOptimisticConcurrencyVersionHolder
are able to hold StateServer object version information and are therefore suitable
for optimistic concurrency.
| |
ITaggable |
An interface you may implement on object types stored in a NamedCache on which
you want to be able to apply arbitrary Tags scoped by the object's NamedCache.
|
Delegates
Delegate | Description | |
---|---|---|
CreateHandler |
A delegate to a method that can return an object using the provided
object identifier and a user-provided parameter.
| |
Deserializer |
A delegate to a method that can deserialize an object previously serialized with Serializer
from the supplied stream. This delegate is used
to establish a custom deserialization callback through the SetCustomSerialization(Serializer, Deserializer) method.
| |
NamedCacheObjectExpiredEventHandler |
Delegate used by the ObjectExpired event.
| |
NamedCacheCreatedEventHandler |
The signature required of methods that handle the NamedCacheCreated event.
| |
Serializer |
A delegate to a method that can serialize an object into a Stream. This delegate is used
to establish a custom serialization callback through the SetCustomSerialization(Serializer, Deserializer) method.
|
Enumerations
Enumeration | Description | |
---|---|---|
BackingStoreAsyncPolicy |
Indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
| |
EvalObjectDisposition |
Specifies the desired disposition of the target object following
execution of an eval method.
| |
GeoServerCoherencyPolicy |
Indicates the type of coherency policy used for GeoServer "pull" replication.
| |
GeoServerReadMode |
An enumeration used to control GeoServer "pull" replication during Retrieve and GetMetadata operations.
| |
HashIndexPriority |
Indicates the priority of an item annotated with SossIndexAttribute for
using the limited slots in the StateServer's property index hashtable. Even if there's
no room for an item in the Hashtable, the item will still be entered into the property
index.
| |
LogoutScope |
Indicates the scope of a logout operation on an application namespace.
| |
MatchOptions |
Options that determine whether all values in a FilterCollection must
match an object's metadata to be considered a match in a Query(IFilter) operation or whether any matching values
constitutes a match for the Query(IFilter) operation.
| |
NamedCacheEventCode |
An enumeration containing the event codes providing the reason an event was fired.
| |
NamedCacheObjDisposition |
An enumeration used to indicate to the cache whether to save or remove an object upon return from a ObjectExpired event handler.
| |
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.
| |
ReadLockingMode |
An enumeration used to control locking behavior during Retrieve and GetMetadata operation.
| |
StatusCodes |
Status code values returned by the StateServer runtime.
| |
TimeoutType |
Enumeration used to indicate the type of timeout an object uses.
| |
UpdateLockingMode |
Enumeration used to control locking behavior during update operations.
|