This documentation is archived and is not being maintained.

StreamingCollection<T> Class

System::Object
  Microsoft.TeamFoundation.Framework.Server::StreamingCollection<T>

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

generic<typename T>
public ref class StreamingCollection : IEnumerable<T>, 
	IEnumerable

Type Parameters

T

The StreamingCollection<T> type exposes the following members.

  NameDescription
Public methodStreamingCollection<T>()Empty constructor required by ASP.NET in order to serialize. This constructor should not be used by a command because it will not have the needed reference to ContinueExecution.
Public methodStreamingCollection<T>(Command)The StreamingCollection constructor that associates this collection to a command that is used to fill the collection with data. This will allow the collection to stream partial data and use the Commands ContinueExecution method data to retrieve that data as it needs it.
Public methodStreamingCollection<T>(Command, Int32)The StreamingCollection constructor that associates this collection to a command that is used to fill the collection with data. This will allow the collection to stream partial data and use the Commands ContinueExecution method data to retrieve that data as it needs it.The estimated cache size of the object
Top

  NameDescription
Public propertyCurrent
Public propertyHandleExceptionsIndicates whether MoveNext() handles exceptions that may occur or rethrows them. By default, this is set to true because the iteration is generally being done by ASP.NET during the serialization process and we cannot just throw an exception to ASP.NET in the middle of this process. However, if a StreamingCollection is being used and iterated over explicitly, the caller would want to set this to false in order to handle any exceptions itself.
Protected propertyHasQueuedDataIndicates whether there is currently data in the cache.
Public propertyIsCompleteOnce the command has filled this collection will all data for this result the command should set IsComplete to True. Do not set IsComplete when the cache is full, only set it after the collection has been fully populated.
Top

  NameDescription
Public methodAddThis version of this method that is required by ASP.NET for XML Serialization. The Command should use the Enqueue(T) method which allows the collection to deal correctly with the cache.
Public methodBindCommandbinds this StreamingCollection to a command
Public methodEnqueueEnqueue is used to add an item to the cache in a FIFO manner. This means that the first item added to the collection is the first item returned to the caller (First In First Out order). This is the method that should be used to handle cache management.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEnumeratorThis collection enables access to the objects through both a generic and non-generic enumerator.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetQueuedItemsEnumeratorReturns a non-destructive enumerator for the items in the queue.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMoveNext
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: