InvocationGrid Class

ScaleOut Software NamedCache API
An object that represents an ScaleOut StateServer invocation grid.
Inheritance Hierarchy

SystemObject
  Soss.ClientInvocationGrid

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

[SerializableAttribute]
public sealed class InvocationGrid

The InvocationGrid type exposes the following members.

Properties

  NameDescription
Public propertyAllowClientCachingInInvokeCallbacks
Gets the value of AllowClientCachingInInvokeCallbacks that was specified via the InvocationGridBuilder. This value controls whether objects fetched in the invocation grid worker process are allowed to be cached in the client cache.
Public propertyAllowFastReads
Gets the value of AllowFastReads that was specified via the InvocationGridBuilder. This value controls whether version information supplied to the invocation grid will be used to determine if cached objects are valid. This value is ignored if LockOnRead is true.
Public propertyDependencies
Returns the list of InvocationGrid dependencies.
Public propertyGridName
Returns the name of this InvocationGrid.
Public propertyIsUnloaded
Returns true if this InvocationGrid has been unloaded from StateServer. Returns false if the grid and its dependencies are still available.
Public propertyLingerTime
Gets the LingerTime for the InvocationGrid.
Public propertyStatic memberLoadedInvocationGrids
Returns all invocation grids loaded by this client.
Public propertyLockOnRead
Gets the value of LockOnRead that was specified via the InvocationGridBuilder. This value controls locking behavior for the invocation grid's worker process, where a value of true will cause the worker process to lock objects during evaluation. The default is false.
Public propertyMaxInvokeWorkerThreads
Gets the value of MaxInvokeWorkerThreads that was specified via the InvocationGridBuilder. This value controls the maximum number of worker threads that the invocation grid's worker process may use. The default is the number of logical processors on the system plus one.
Public propertyMaxWorkerCacheKB
Gets the maximum size of the invocation grid workers' client-side cache in kilobytes that was specified in via MaxWorkerCacheKB property for the InvocationGridBuilder that was used to Load this InvocationGrid.
Top
Methods

  NameDescription
Public methodEquals
Performs a equality comparison by value. Two InvocationGrid instances are considered equal if they have the same GridName, LingerTime, MaxWorkerCacheKB, AllowClientCachingInInvokeCallbacks, MaxInvokeWorkerThreads, LockOnRead, AllowFastReads and dependencies.
(Overrides ObjectEquals(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
Returns a hash code for this InvocationGrid instance that is compatible with Equals(Object).
(Overrides ObjectGetHashCode.)
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.)
Public methodUnload
Unloads this InvocationGrid from the StateServer and stops all invocation workers corresponding to this GridName.
Public methodStatic memberUnloadAll
Unloads all InvocationGrids loaded by this client. This method does not affect invocation grids loaded by other clients.
Top
Remarks

An InvocationGrid is used to pre-load code dependencies to servers involved in a parallel method invocation environment and to start remote host processes for running the parallel method invocations on those servers. This class also provides a mechanism for unloading InvocationGrid by calling Unload
See Also

Reference