PipeStream Class

 

Exposes a Stream object around a pipe, which supports both anonymous and named pipes.

Namespace:   System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.IO.Pipes.PipeStream
        System.IO.Pipes.AnonymousPipeClientStream
        System.IO.Pipes.AnonymousPipeServerStream
        System.IO.Pipes.NamedPipeClientStream
        System.IO.Pipes.NamedPipeServerStream

[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public abstract class PipeStream : Stream

NameDescription
System_CAPS_protmethodPipeStream(PipeDirection, Int32)

Initializes a new instance of the PipeStream class using the specified PipeDirection value and buffer size.

System_CAPS_protmethodPipeStream(PipeDirection, PipeTransmissionMode, Int32)

Initializes a new instance of the PipeStream class using the specified PipeDirection, PipeTransmissionMode, and buffer size.

NameDescription
System_CAPS_pubpropertyCanRead

Gets a value indicating whether the current stream supports read operations.(Overrides Stream.CanRead.)

System_CAPS_pubpropertyCanSeek

Gets a value indicating whether the current stream supports seek operations.(Overrides Stream.CanSeek.)

System_CAPS_pubpropertyCanTimeout

Gets a value that determines whether the current stream can time out.(Inherited from Stream.)

System_CAPS_pubpropertyCanWrite

Gets a value indicating whether the current stream supports write operations.(Overrides Stream.CanWrite.)

System_CAPS_pubpropertyInBufferSize

Gets the size, in bytes, of the inbound buffer for a pipe.

System_CAPS_pubpropertyIsAsync

Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously.

System_CAPS_pubpropertyIsConnected

Gets or sets a value indicating whether a PipeStream object is connected.

System_CAPS_protpropertyIsHandleExposed

Gets a value indicating whether a handle to a PipeStream object is exposed.

System_CAPS_pubpropertyIsMessageComplete

Gets a value indicating whether there is more data in the message returned from the most recent read operation.

System_CAPS_pubpropertyLength

Gets the length of a stream, in bytes.(Overrides Stream.Length.)

System_CAPS_pubpropertyOutBufferSize

Gets the size, in bytes, of the outbound buffer for a pipe.

System_CAPS_pubpropertyPosition

Gets or sets the current position of the current stream.(Overrides Stream.Position.)

System_CAPS_pubpropertyReadMode

Gets or sets the reading mode for a PipeStream object.

System_CAPS_pubpropertyReadTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)

System_CAPS_pubpropertySafePipeHandle

Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates.

System_CAPS_pubpropertyTransmissionMode

Gets the pipe transmission mode supported by the current pipe.

System_CAPS_pubpropertyWriteTimeout

Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)

NameDescription
System_CAPS_pubmethodBeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous read operation.(Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodBeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous write operation.(Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_protmethodCheckPipePropertyOperations()

This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the pipe is in a proper state for getting or setting properties.

System_CAPS_protmethodCheckReadOperations()

This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the pipe is in a connected state for read operations.

System_CAPS_protmethodCheckWriteOperations()

This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the pipe is in a connected state for write operations.

System_CAPS_pubmethodClose()

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32, CancellationToken)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.(Inherited from Stream.)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodCreateWaitHandle()

Obsolete.Allocates a WaitHandle object.(Inherited from Stream.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Stream.(Inherited from Stream.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources.(Overrides Stream.Dispose(Boolean).)

System_CAPS_pubmethodEndRead(IAsyncResult)

Ends a pending asynchronous read request.(Overrides Stream.EndRead(IAsyncResult).)

System_CAPS_pubmethodEndWrite(IAsyncResult)

Ends a pending asynchronous write request.(Overrides Stream.EndWrite(IAsyncResult).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.(Overrides Stream.Flush().)

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodGetAccessControl()

Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInitializeHandle(SafePipeHandle, Boolean, Boolean)

Initializes a PipeStream object from the specified SafePipeHandle object.

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodObjectInvariant()

Obsolete. This API supports the product infrastructure and is not intended to be used directly from your code. Provides support for a Contract.(Inherited from Stream.)

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

Reads a block of bytes from a stream and writes the data to a specified buffer.(Overrides Stream.Read(Byte[], Int32, Int32).)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32)

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.(Inherited from Stream.)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodReadByte()

Reads a byte from a pipe.(Overrides Stream.ReadByte().)

System_CAPS_pubmethodSeek(Int64, SeekOrigin)

Sets the current position of the current stream to the specified value.(Overrides Stream.Seek(Int64, SeekOrigin).)

System_CAPS_pubmethodSetAccessControl(PipeSecurity)

Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object.

System_CAPS_pubmethodSetLength(Int64)

Sets the length of the current stream to the specified value.(Overrides Stream.SetLength(Int64).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWaitForPipeDrain()

Waits for the other end of the pipe to read all sent bytes.

System_CAPS_pubmethodWrite(Byte[], Int32, Int32)

Writes a block of bytes to the current stream using data from a buffer.(Overrides Stream.Write(Byte[], Int32, Int32).)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32)

Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.(Inherited from Stream.)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current stream.(Overrides Stream.WriteByte(Byte).)

The PipeStream class provides the base class for named and anonymous pipes operations in the .NET Framework. Use the NamedPipeServerStream and NamedPipeClientStream classes for named pipe operations. Use the AnonymousPipeServerStream and AnonymousPipeClientStream classes for anonymous pipe operations.

For more information about pipes, see Pipe Operations in the .NET Framework. For an example of anonymous pipes, see How to: Use Anonymous Pipes for Local Interprocess Communication. For an example of named pipes, see How to: Use Named Pipes for Network Interprocess Communication.

InheritanceDemand

for full trust for inheritors. This class cannot be inherited by partially trusted code.

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: