CreatePolicy Class

ScaleOut Software NamedCache API
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.
Inheritance Hierarchy

SystemObject
  Soss.ClientCreatePolicy

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

[SerializableAttribute]
public class CreatePolicy

The CreatePolicy type exposes the following members.

Constructors

  NameDescription
Public methodCreatePolicy
Creates a CreatePolicy object with an infinite timeout. Objects will be subject to reclamation under low-memory circumstances, will eligible for GeoServer push replication, and will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(Int32)
Creates a CreatePolicy object with a sliding timeout of the specified duration. Objects will be subject to reclamation under low-memory circumstances, will eligible for GeoServer push replication, and will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(TimeSpan)
Creates a CreatePolicy object with a sliding timeout of the specified duration. Objects will be subject to reclamation under low-memory circumstances, will eligible for GeoServer push replication, and will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(Int32, Boolean)
Creates a CreatePolicy object with a timeout of the specified duration that is either sliding or absolute. Objects will be subject to reclamation under low-memory circumstances, will eligible for GeoServer push replication, and will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(TimeSpan, Boolean)
Creates a CreatePolicy object with a timeout of the specified duration that is either sliding or absolute. Objects will be subject to reclamation under low-memory circumstances, will eligible for GeoServer push replication, and will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(Int32, Boolean, ObjectPreemptionPriority, Object, Boolean)
Creates a CreatePolicy object with the specified policies for timeout, preemption priority, dependencies, and GeoServer push replication. Objects will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(TimeSpan, Boolean, ObjectPreemptionPriority, Object, Boolean)
Creates a CreatePolicy object with the specified policies for timeout, preemption priority, dependencies, and GeoServer push replication. Objects will not be remotely accessible to a remote store via GeoServer pull replication.
Public methodCreatePolicy(TimeSpan, Boolean, ObjectPreemptionPriority, Object, Boolean, Boolean, ICoherencyPolicy)
Creates a CreatePolicy object.
Top
Properties

  NameDescription
Public propertyAllowRemoteAccess
Gets/sets whether the object to be added to the cache will be accessible to remote stores via GeoServer "pull" replication. The default value is true. Use the DefaultCoherencyPolicy property to specify how remote stores refresh their proxies of this object.
Public propertyAllowReplication
Gets/sets whether the object to be added to the cache will be subject to GeoServer cross-store "push" replication.
Public propertyBackingStoreInterval
Gets/sets the interval between asynchronous backing store events (refresh-ahead, write-behind).
Public propertyBackingStoreMode
Gets/sets the associated object's BackingStoreAsyncPolicy. Default is None.
Public propertyDefaultCoherencyPolicy
Gets/sets the policy determining how remote stores will refresh their proxies of this object. Currently supported policy types are NotifyCoherencyPolicy and PollingCoherencyPolicy. Set this property to null to prevent remote stores from automatically refreshing their proxies for this object. The default value is a PollingCoherencyPolicy with an polling interval of 60 seconds.
Public propertyDependencies
Gets/sets keys to objects on which the object being added depends. Items in the array must be of type string, byte[], Guid, or StateServerKey. An object can be dependent upon up to 2 parent objects. Keys to parents that do not exist in the store will be ignored.
Public propertyIsAbsoluteTimeout
Gets/sets whether the timeout is an absolute expiration value or is a sliding expiration value that gets reset every time the object is accessed.
Public propertyIsAbsoluteTimeoutOnRead
Gets/sets whether the timeout is an absolute expiration value or is a sliding expiration value that gets reset every time the object updated. (This property is overridden by the IsAbsoluteTimeout property, which resets the expiration if the object is updated or read.)
Public propertyPreemptionPriority
Gets/sets the priority of keeping the object in the cache during low-memory situations. Removable objects are removed from memory when memory runs low based on a least recently used algorithm.
Public propertyTimeout
Gets/sets the timeout until the object expires, with a minimum granularity of one second. Use Zero for an infinite timeout.
Public propertyTimeoutMinutes
Gets/sets the timeout until the object expires, rounded to the nearest minute. 0 for an infinite timeout.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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
Serves as the default hash function.
(Inherited from Object.)
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 a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference