PipelineReader<T> Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
PipelineReader provides asynchronous access to the stream of objects emitted by a Pipeline.
generic <typename T>
public ref class PipelineReader abstract
public abstract class PipelineReader<T>
type PipelineReader<'T> = class
Public MustInherit Class PipelineReader(Of T)
Type Parameters
- T
- Inheritance
-
PipelineReader<T>
Constructors
PipelineReader<T>() |
Properties
Count |
Returns the number of objects currently available in the underlying stream. |
EndOfPipeline |
Check if the stream is closed and contains no data. |
IsOpen |
Check if the stream is open for further writes. |
MaxCapacity |
Get the capacity of the stream. |
WaitHandle |
Signaled when data is available. |
Methods
Close() |
Close the stream. |
NonBlockingRead() |
Reads all objects currently in the stream, but does not block. |
NonBlockingRead(Int32) |
Reads objects currently in the stream, but does not block. |
Peek() |
Peek the next object, but do not remove it from the stream. Non-blocking. |
Read() |
Read a single object from the stream. |
Read(Int32) |
Read at most |
ReadToEnd() |
Blocks until the pipeline closes and reads all objects. |
Events
DataReady |
Event fired when data is added to the buffer. |