Class PipeStream

Namespace

Renci.SshNet.Common

Assembly

Renci.SshNet.dll

PipeStream is a thread-safe read/write data stream for use between two threads in a single-producer/single-consumer type problem.

public class PipeStream : Stream, IDisposable, IAsyncDisposable

Inheritance

object

MarshalByRefObject

Stream

PipeStream

Implements

IDisposable

IAsyncDisposable

Inherited Members

Stream.Null

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.Dispose()

Stream.Close()

Stream.DisposeAsync()

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.CreateWaitHandle()

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.EndRead(IAsyncResult)

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.ReadAsync(Memory<byte>, CancellationToken)

Stream.ReadExactlyAsync(Memory<byte>, CancellationToken)

Stream.ReadExactlyAsync(byte[], int, int, CancellationToken)

Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.EndWrite(IAsyncResult)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.Read(Span<byte>)

Stream.ReadByte()

Stream.ReadExactly(Span<byte>)

Stream.ReadExactly(byte[], int, int)

Stream.ReadAtLeast(Span<byte>, int, bool)

Stream.Write(ReadOnlySpan<byte>)

Stream.WriteByte(byte)

Stream.Synchronized(Stream)

Stream.ObjectInvariant()

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.CanTimeout

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PipeStream()

public PipeStream()

Properties

CanRead

Gets a value indicating whether the current stream supports reading.

public override bool CanRead { get; }

Property Value

bool

true.

Remarks

It is safe to read from PipeStream even after disposal.

CanSeek

Gets a value indicating whether the current stream supports seeking.

public override bool CanSeek { get; }

Property Value

bool

false.

CanWrite

Gets a value indicating whether the current stream supports writing.

public override bool CanWrite { get; }

Property Value

bool

true if this stream has not been disposed and the underlying channel is still open, otherwise false.

Remarks

A value of true does not necessarily mean a write will succeed. It is possible that the stream is disposed by another thread between a call to CanWrite and the call to write.

Length

Gets the number of bytes currently available for reading.

public override long Length { get; }

Property Value

long

A long value representing the length of the stream in bytes.

Position

This property always returns 0, and throws NotSupportedException when calling the setter.

public override long Position { get; set; }

Property Value

long

Exceptions

NotSupportedException

The setter is called.

Methods

Dispose(bool)

protected override void Dispose(bool disposing)

Parameters

disposing bool

Flush()

This method does nothing.

public override void Flush()

Read(byte[], int, int)

public override int Read(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

offset int

count int

Returns

int

Seek(long, SeekOrigin)

This method always throws NotSupportedException.

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long

A byte offset relative to the origin parameter.

origin SeekOrigin

A value of type SeekOrigin indicating the reference point used to obtain the new position.

Returns

long

Never.

Exceptions

NotSupportedException

Always.

SetLength(long)

This method always throws NotSupportedException.

public override void SetLength(long value)

Parameters

value long

The desired length of the current stream in bytes.

Exceptions

NotSupportedException

Always.

Write(byte[], int, int)

public override void Write(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

offset int

count int