SossIndexAttribute Class

ScaleOut Software NamedCache API
A marker Attribute that indicates that the property or class to which it applies should be saved in the StateServer property index when instances of the class are created or updated.
Inheritance Hierarchy

SystemObject
  SystemAttribute
    Soss.ClientSossIndexAttribute

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

public sealed class SossIndexAttribute : Attribute

The SossIndexAttribute type exposes the following members.

Constructors

  NameDescription
Public methodSossIndexAttribute
Create an Attribute used to indicate that the value or type signature of the annotated language element should be written to StateServer's property index.
Public methodSossIndexAttribute(HashIndexPriority)
Create an Attribute used to indicate that the value or type signature of the annotated language element should be written to StateServer's property index.
Top
Properties

  NameDescription
Public propertyHashPriority
Returns the HashIndexPriority established when this attribute was constructed (see SossIndexAttribute(HashIndexPriority)). Returns null if the default constructor was used (see [M:Soss.Client.SossIndexAttribute.SossIndexAttribute()]).
Public propertyTypeId
When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute.)
Top
Methods

  NameDescription
Public methodEquals
Returns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute.)
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 Attribute.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsDefaultAttribute
When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute.)
Public methodMatch
When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute.)
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
Remarks

When you annotate selected properties of a class with SossIndexAttribute you indicate that the values of those properties should be saved in the StateServer's property index whenever an instance of the class is created or updated. Information about the class's Type and Type hierarchy are also included in the information saved in the property index. If you want to be able to query StateServer for instances of a class but don't need to save any property values within the property index, you can annotate the class itself with the SossIndexAttribute.

It is not meaningful to annotate static properties with this attribute. Such annotations are ignored.

If the property does not have a "getter" the attribute is ignored.

While you can annotate the properties of interfaces with SossIndexAttribute, type signature information for interfaces is never saved in the StateServer property index.

See Also

Reference

Other Resources