Share via

PipelineReader<T> Class

  • Reference

Definition

Namespace:
System.Management.Automation.Runspaces
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

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
Object
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 count objects.
ReadToEnd()

Blocks until the pipeline closes and reads all objects.

Events

DataReady

Event fired when data is added to the buffer.

Applies to

See also