StreamChain Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.IntelliTrace
Assembly:
Microsoft.IntelliTrace.Core.dll

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

public ref class StreamChain abstract : Microsoft::VisualStudio::IntelliTrace::RootChain
[Windows::Foundation::Metadata::WebHostHidden]
public ref class StreamChain abstract : Microsoft::VisualStudio::IntelliTrace::RootChain
[Windows::Foundation::Metadata::WebHostHidden]
class StreamChain abstract : Microsoft::VisualStudio::IntelliTrace::RootChain
public abstract class StreamChain : Microsoft.VisualStudio.IntelliTrace.RootChain
type StreamChain = class
    inherit RootChain
Public MustInherit Class StreamChain
Inherits RootChain
Inheritance
Object
Chain
RootChain
StreamChain
Derived

Properties

Access

Gets the type of access permitted to the chain.

(Inherited from RootChain)
AfterLastToken

Gets an EventToken for the position immediately after the current LastToken. If additional events get added to the chain, the token returned from AfterLastToken will become valid. This property is available even if CanGetLastToken returns false.
BeforeFirstToken

Gets an EventToken for the position immediately before FirstToken. This token will never become valid.

(Inherited from Chain)
CanGetCount

Gets a value that determines if the chain supports Count.

(Inherited from Chain)
CanGetLastToken

Gets a value that determines if the chain supports LastToken.

(Inherited from Chain)
CanGetPreviousToken

Gets a value that determines if the chain supports GetPreviousToken(EventToken).

(Inherited from Chain)
Count

Gets the number of events in the chain. This property can only be called if CanGetCount returns true.

(Inherited from Chain)
FirstToken

Gets an EventToken for the first event in the chain.
FirstValidToken

Gets an EventToken for the first valid event in the chain.
IsEmpty

Gets a value that indicates if the chain is empty.
LastToken

Gets an EventToken for the last event in the chain. This property can only be called if CanGetLastToken returns true.

(Inherited from Chain)

Methods

AppendEvent(IntelliTraceEvent)

Appends an IntelliTraceEvent to a stream.
ConvertToBytes(IntelliTraceEvent)

When overridden in a derived class, converts an IntelliTraceEvent to a raw event.
ConvertToEvent(EventToken, Byte[], Int32)

When overridden in a derived class, converts a raw event to an IntelliTraceEvent.
Dispose()

Releases resources used by this chain.

(Inherited from Chain)
Dispose(Boolean)

Releases the resources used by this chain.
GetEnumerator() (Inherited from Chain)
GetEnumerator<TEvent>() (Inherited from Chain)
GetEvent(EventToken)

Gets an IntelliTraceEvent for the specified EventToken.
GetEvents(EventToken, EventToken)

Gets multiple IntelliTraceEvents from a start EventToken up to but not including an end EventToken.
GetNextToken(EventToken)

Gets the EventToken for the next event after the given EventToken.
GetPreviousToken(EventToken)

Gets the EventToken for the previous event before the given EventToken.

(Inherited from Chain)
IsValidEventType(IntelliTraceEvent)

When overridden in a derived class, determines if the given IntelliTraceEvent is valid for this chain.

(Inherited from Chain)
IsValidToken(EventToken)

Determines if the given EventToken is valid for this chain.
ReadEventBytes()

When overridden in a derived class, reads a single raw event from the stream.
ReadEventLength()

When overridden in a derived class, gets the length of the next event in the stream.
Tokens() (Inherited from Chain)

Explicit Interface Implementations

IEnumerable.GetEnumerator() (Inherited from Chain)

Extension Methods

EmptyIfNull<T>(IEnumerable<T>)

Applies to