IndexCollection Class

ScaleOut Software NamedCache API
A collection of IndexValues which may be supplied to State Server in either query/filter operations or when specifying metadata values.
Inheritance Hierarchy

SystemObject
  Soss.ClientIndexCollection
    Soss.ClientFilterCollection

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

[SerializableAttribute]
public class IndexCollection : IList, 
	ICollection, IEnumerable, IFilter

The IndexCollection type exposes the following members.

Constructors

  NameDescription
Public methodIndexCollection
Create a new IndexCollection instance.
Top
Properties

  NameDescription
Public propertyCount
Gets the number of elements in the IndexCollection. Since the collection is fixed-size, this property always returns MaxIndexValues.
Public propertyIsFixedSize
Returns true.
Public propertyIsReadOnly
Returns false.
Public propertyIsSynchronized
Returns false. Callers may synchronize the list using SyncRoot.
Public propertyItem
Gets or sets the element at the specified index.
Public propertyStatic memberMaxIndexValues
The fixed number of IndexValues an IndexCollection may hold. This value is currently 8.
Public propertySyncRoot
Gets an object that can be used to synchronize access to the IndexCollection.
Top
Methods

  NameDescription
Public methodClear
Sets the value of all IndexValue instances in the collection to null.
Public methodClear(Int32)
Sets the value of the IndexValue instance at the specified index to a default (unused) value.
Public methodContains
Tests to see if the collection contains value. Note that IndexValues are compared by value, not by reference. See Equals(Object).
Public methodCopyTo
Copies the entire contents of this collection to a compatible, one-dimensional Array, starting at the specified index in the target array.
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 methodGetEnumerator
Returns an enumerator for this IndexCollection.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIndexCollection
Return this IndexCollection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified IndexValue and returns the zero-based index of the first occurrence within the IndexCollection.
Public methodInsert
Inserts an element into the IndexCollection at the specified index.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove
Removes the first occurrence of a specific IndexValue from the IndexCollection.
Public methodRemoveAt
Removes the element at the specified index of the IndexCollection.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

IndexCollections are fixed-length collections where the length is defined by the StateServer implementation. Not all index positions need have values. That is, an IndexCollection may be sparsely filled in.

Since IndexCollection implements IFilter, an IndexCollection instance may be used as the filter parameter for query and method invocation operations.

See Also

Reference