RetrieveOptions Structure

ScaleOut Software NamedCache API
Struct containing options that can be used when retrieving an object from ScaleOut StateServer.

Namespace:  Soss.Client
Assembly:  soss_namedcache (in soss_namedcache.dll) Version:

public struct RetrieveOptions

The RetrieveOptions type exposes the following members.


Public methodRetrieveOptions(ReadLockingMode, GeoServerReadMode)
Public methodRetrieveOptions(ReadLockingMode, GeoServerReadMode, CreateHandler, Object, CreatePolicy)

Public propertyCreateArgument
Gets/set an argument that will be passed to the provided CreateHandler callback if a missing object is to be created. The default is null.
Public propertyCode exampleCreateHandler
Gets/sets the optional, custom object creation callback to use when an attempt is made to retrieve an object that is not in the cache. The default is null.
Public propertyCreatePolicy
Gets/sets the cache policy object to be used when a Retrieve(String, RetrieveOptions) operation is configured to transparently insert a missing object into the named cache using CreateHandler. The default is null.
Public propertyGeoServerReadMode
Gets/sets GeoServer "pull" replication behavior when retrieving the object from the StateServer. Default is None.
Public propertyLockingMode
Gets/sets whether the Retrieve method should attempt to acquire a StateServer lock when reading the object. Default is NoLockOnRead.

Public methodEquals
Indicates whether this instance and a specified object are equal.
(Inherited from ValueType.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Returns the hash code for this instance.
(Inherited from ValueType.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns the fully qualified type name of this instance.
(Inherited from ValueType.)
See Also