FilteredStreamChain Class

Article
04/26/2013

Provides a stream of events recorded from a running application.StreamChain provides on-demand access and instantiation of events in the stream when GetEvent or GetEvents is called. IntelliTraceEvents are not stored by the StreamChain.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.IntelliTrace.Chain
    Microsoft.VisualStudio.IntelliTrace.RootChain
      Microsoft.VisualStudio.IntelliTrace.StreamChain
        Microsoft.VisualStudio.IntelliTrace.FilteredStreamChain
          Microsoft.VisualStudio.IntelliTrace.IntelliTraceTokenStreamChain
          Microsoft.VisualStudio.IntelliTrace.MetadataStreamChain

Namespace: Microsoft.VisualStudio.IntelliTrace
Assembly: Microsoft.IntelliTrace.11.0.0 (in Microsoft.IntelliTrace.11.0.0.dll)

Syntax

'Declaration
Public MustInherit Class FilteredStreamChain _
    Inherits StreamChain

public abstract class FilteredStreamChain : StreamChain

public ref class FilteredStreamChain abstract : public StreamChain

[<AbstractClass>]
type FilteredStreamChain =  
    class 
        inherit StreamChain 
    end

public abstract class FilteredStreamChain extends StreamChain

The FilteredStreamChain type exposes the following members.

Properties

	Name	Description
	Access	Gets the type of access that is permitted to the chain. (Inherited from RootChain.)
	AfterLastToken	Gets an EventToken for the position that is immediately after the current LastToken. (Inherited from StreamChain.)
	BeforeFirstToken	Gets an EventToken for the position that is immediately before FirstToken. (Inherited from Chain.)
	CanGetCount	Gets a value that determines whether the chain supports Count. (Inherited from Chain.)
	CanGetLastToken	Gets a value that determines whether the chain supports LastToken. (Inherited from Chain.)
	CanGetPreviousToken	Gets a value that determines whether the chain supports GetPreviousToken. (Inherited from Chain.)
	Count	Gets the number of events in the chain. (Inherited from Chain.)
	FirstToken	Gets an EventToken for the first event in the chain. (Overrides StreamChain.FirstToken.)
	FirstValidToken	Gets an EventToken for the first valid event in the chain. (Overrides StreamChain.FirstValidToken.)
	IsEmpty	Gets a value that indicates whether the chain is empty. (Inherited from StreamChain.)
	LastToken	Gets an EventToken for the last event in the chain. (Inherited from Chain.)

Top

Methods

	Name	Description
	AppendEvent	Appends an IntelliTraceEvent to a stream. (Inherited from StreamChain.)
	ConvertToBytes	When overridden in a derived class, converts an IntelliTraceEvent to a raw event. (Inherited from StreamChain.)
	ConvertToEvent	(Inherited from StreamChain.)
	Dispose()	(Inherited from Chain.)
	Dispose(Boolean)	Releases the resources that are used by this chain. (Inherited from StreamChain.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FilteredEvent	Gets a value that determines whether the event pointed to by token is in the filter list.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator<TEvent>()	(Inherited from Chain.)
	GetEvent	(Overrides StreamChain.GetEvent(EventToken).)
	GetEvents	Gets multiple IntelliTraceEvents from a start EventToken up to but excluding an end EventToken. (Overrides StreamChain.GetEvents(EventToken, EventToken).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetNextToken	Gets the EventToken for the next event after the given EventToken. (Overrides StreamChain.GetNextToken(EventToken).)
	GetPreviousToken	Gets the EventToken for the previous event before the given EventToken. (Inherited from Chain.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsValidEventType	When overridden in a derived class, determines whether the given IntelliTraceEvent is valid for this chain. (Inherited from Chain.)
	IsValidToken	Determines whether the given EventToken is valid for this chain. (Inherited from StreamChain.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadEventBytes	When overridden in a derived class, reads a single raw event from the stream. (Inherited from StreamChain.)
	ReadEventId	When overridden in a derived class, reads the event ID for the specified event.
	ReadEventLength	When overridden in a derived class, gets the length of the next event in the stream. (Inherited from StreamChain.)
	SkipToNextUnfilteredEvent	If the specified token points to an event that should be filtered for this FilteredStreamChain, skips all filtered events to the next event that is not in the filter list. If the specified token points to an event not in the filter list, the same EventToken is returned.
	Tokens	(Inherited from Chain.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)