Namespace Scaleout.Client
Classes
- AuthorizationNotNeededException
A ScaleoutException specialization that indicates that a login was performed on a cache that does not require authorization.
- BootstrapGateway
Bootstrap gateway specification returned from a GetAsync() implementation.
- BootstrapGatewayProvider
Abstract base class for a bootstrap gateway provider that can be used for connecting to ScaleOut hosts in a cloud environment.
- Cache
Base class for typed Cache<TKey, TValue>. For internal use only.
- CacheBuilder<TKey, TValue>
Provides custom construction of a ScaleOut Cache<TKey, TValue> instance.
- CacheInfo
Contains information and statistics related to a cache namespace in the ScaleOut service.
- CacheResponse<TKey, TValue>
Represents a response from a request to the ScaleOut service.
- Cache<TKey, TValue>
Provides access to a named group of objects that can be shared across multiple clients.
- CreatePolicy
Specifies object policy information when adding objects to a Cache<TKey, TValue>. Objects of this type are immutable and created using a CreatePolicyBuilder. Use GetPolicyBuilder() to get a builder with policies preset to a cache's defaults.
- CreatePolicyBuilder
Builder class to create immutable CreatePolicy objects. Use GetPolicyBuilder() to get a builder with policies preset to a cache's defaults.
- EventHandlerException
Exception indicating that an error occurred while handling an event from the ScaleOut service.
- EventPayload
Contains information about an event that was pushed from a ScaleOut client (via PostEventAsync(TKey, string, byte[], TimeSpan?)) to an event source.
- GridConnection
Represents connection(s) to one or more servers in a ScaleOut in-memory data grid. A GridConnection instance is thread-safe, long-lived, and maintains a pool of TCP connections to ScaleOut hosts. Multiple Cache<TKey, TValue> instances should use the same GridConnection instance if they are connecting to the same ScaleOut cluster.
- InvokeResponse
Represents a response from a invoke request to the ScaleOut service.
- LegacyXmlConfiguration
IConfiguration implementation for use with the CacheBuilder when using the .NET Framework's System.Configuration infrastructure (web.config and app.config files).
- LocalStoreNameConfigurationException
A ScaleoutException specialization that indicates that the local store name has not been configured for GeoServer replication.
- LockLostException
A ScaleoutException specialization that indicates that a caller no longer has a lock on an object in the ScaleOut service.
- MultipleLoginException
A ScaleoutException specialization that indicates that multiple users attempted to login to the same cache from the same client application.
- NoActiveRemoteStoreException
A ScaleoutException specialization that indicates that none of the remote stores from the list provided to the SetRemoteStoreAccess method is active or exists.
- NotAuthorizedException
A ScaleoutException specialization that indicates that an operation failed in the ScaleOut service because of authorization restrictions.
- NotLicensedException
A ScaleoutException specialization that indicates that a client cannot access State Server because the client is not licensed.
- NotReadyException
A ScaleoutException 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 ScaleoutException specialization that indicates that an Add call failed because an object already exists in the StateServer with the given key.
- ObjectLockedException
A ScaleoutException specialization that indicates that the requested object was locked in the ScaleOut service and couldn't be exclusively accessed.
- ObjectMetadata
Provides information about an object that is stored in ScaleOut service, including user-specified metadata and additional metadata that is maintained by the ScaleOut service.
- ObjectNotFoundException
A ScaleoutException specialization that indicates that an error occurred because the object associated with the provided key was not found.
- OperationNotImplementedException
A ScaleoutException specialization that indicates that an operation is not supported in the current version of the ScaleOut StateServer service.
- OptimisticLockException
A ScaleoutException specialization that indicates that the requested StateServer object was locked and couldn't be accessed.
- ReadThroughPendingException
A ScaleoutException 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 either (1) another client that is creating this object in the StateServer from a backing store (such as a database) or by (2) a pending GeoServer replication operation.
- ReadThroughTimeoutException
A <xref href="Scaleout.Client.ScaleoutException" data-throw-if-not-resolved="false"></xref> specialization indicating that a read-through operation to a backing store (such as a database)or a remote GeoServer store has timed out.
- RemoteStoreAccessException
A ScaleoutException 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).
- ScaleoutException
An exception thrown when an unexpected error occurs while accessing the ScaleOut service.
- ScaleoutMemoryException
A ScaleoutException specialization that indicates that the server has insufficient free memory to perform the requested operation.
- ScaleoutServiceUnavailableException
A ScaleoutException specialization that indicates that a ScaleOut call failed because the client was unable to open a connection to the local StateServer.
- SerializationException
Exception thrown when an error occurs during serialization or deserialization.
- ServiceEvents
Manages registration of callbacks to handle events from the ScaleOut service.
- SingleObjectInvokeArgs
Contains user-supplied arguments that was pushed from a ScaleOut client (via ) to a SingleObjectInvoke event handling callback.
- TimeoutException
A ScaleoutException 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.
- UpdatePolicy
Specifies object policy changes to make when updating an object in the ScaleOut service.
- ValueFactoryResult<TValue>
Result to return from the valueFactory callback supplied to ReadOrAddAsync(TKey, Func<TKey, ValueFactoryResult<TValue>>, ReadOptions, CancellationToken) or SetLoadObjectHandlerAsync<TKey, TValue>(Cache<TKey, TValue>, Func<TKey, Task<ValueFactoryResult<TValue>>>). Allows an object's value, policies, and tags to be specified by a valueFactory callback.
Structs
- DependencySpec
A dependency specification that can be supplied to a CreatePolicy when adding dependant (child) objects to a cache.
- LockToken
An identifier for a lock that is held on an object in the ScaleOut service.
- ReadOptions
Options that can be used when retrieving an object from the ScaleOut service.
- VersionToken
An identifier for a specific version of an object held in the ScaleOut service. Version tokens can be used for optimistic updates via the UpdateOptimisticAsync(TKey, TValue, VersionToken, UpdatePolicy, IEnumerable<string>, CancellationToken) method.
Enums
- BackingStoreMode
Indicates the type of asynchronous backing-store behavior that the server should invoke for an object.
- ClientCacheUsage
Enumeration used to control client cache usage during read operations.
- ExpirationType
Enumeration to indicate the reason an expiration event was fired.
- GeoServerCoherencyPolicy
Indicates the type of coherency policy used for GeoServer "pull" replication.
- GeoServerPullPolicy
Enumeration used to indicate whether objects to the cache will be accessible to remote stores via GeoServer "pull" replication.
- GeoServerPushPolicy
Enumeration used to indicate whether objects to be added to the cache will be subject to GeoServer cross-store "push" replication.
- GeoServerReadMode
An enumeration used to control GeoServer "pull" replication during Read operations.
- InProcCacheResult
An enumeration indicating how the in-process client cache was used during the operation.
- ObjectDisposition
An enumeration returned from an object expiration handler to indicate to the service whether the expiring object should be saved or removed.
- PreemptionPriority
Enumeration used to indicate the priority of keeping a given object in the ScaleOut service under low-memory conditions. Removable objects are removed from memory when memory runs low based on a least recently used algorithm.
- ServerResult
An enumeration that indicates the outcome of a cache operation.
- TimeoutType
Enumeration used to indicate the type of timeout an object uses.