StateServerKey Structure

ScaleOut Software NamedCache API
An immutable value type that holds a representation for the identity of an object on StateServer.

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

[SerializableAttribute]
public struct StateServerKey : ISerializable

The StateServerKey type exposes the following members.

Properties

  NameDescription
Public propertyAppId
Return the identifier used as the application identifier for separating distinct namespaces of keys on the store.
Public propertyStatic memberAspSessionAppId
Return the application ID corresponding to the ASP.Net application name of the AppDomain we're currently executing in.
Public propertyStatic memberDefaultAppId
Gets or sets the default AppId to use when creating StateServerKey instance using the #ctor(Guid), #ctor(Byte), or #ctor(Byte, String) constructors.
Top
Methods

  NameDescription
Public methodStatic memberAppNameToId(String)
Returns the application ID corresponding to the application name appName.
Public methodStatic memberAppNameToId(String, Boolean)
Return the application ID corresponding to the application name appName and optionally register with StateServer for event callbacks for the specified application name.
Public methodEquals
Compare another object with this StateServerKey.
(Overrides ValueTypeEquals(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
Return an integer value suitable for hashtable lookups. The value returned has the property that if a and b are both StateServerKey objects and if a.Equals(b) then a.GetHashCode() == b.GetHashCode().
(Overrides ValueTypeGetHashCode.)
Public methodGetKeyString
Retrieves the original (unhashed) string used as a key to a StateServer object.
Public methodGetObjectData
Support for the ISerializable interface. Populates a StateServerKey with the data needed to serialize the target 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 methodToByteArray
Return a copy of the key as an array of bytes. The AppId is not included in this array. See AppId to retrieve the AppId value used in this key.
Public methodToString
Return a human-consumable representation of this key value.
(Overrides ValueTypeToString.)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compare two StateServerKey objects returning true if they're equal.
Public operatorStatic memberInequality
Compare two StateServerKey objects returning true if they're not equal.
Top
Remarks

A DataAccessor holds a StateServerKey to uniquely identify the StateServer object it accesses.

Given a StateServerKey, you may create an appropriate DataAccessor instance via the factory method CreateDataAccessor(StateServerKey).

Thread Safety

Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
See Also

Reference