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: 6.2.0.0

Syntax

public struct RetrieveOptions

Public Structure RetrieveOptions

The RetrieveOptions type exposes the following members.

Constructors

	Name	Description
	RetrieveOptions(ReadLockingMode, GeoServerReadMode)	Constructor
	RetrieveOptions(ReadLockingMode, GeoServerReadMode, CreateHandler, Object, CreatePolicy)	Constructor

Properties

	Name	Description
	CreateArgument	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.
	CreateHandler	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.
	CreatePolicy	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.
	GeoServerReadMode	Gets/sets GeoServer "pull" replication behavior when retrieving the object from the StateServer. Default is None.
	LockingMode	Gets/sets whether the Retrieve method should attempt to acquire a StateServer lock when reading the object. Default is NoLockOnRead.

Methods

	Name	Description
	Equals	Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from ValueType.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)