Export (0) Print
Expand All

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)

[<AbstractClass>]
[<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)>]
type PipeStream =  
    class 
        inherit Stream 
    end

The PipeStream type exposes the following members.

  NameDescription
Protected methodPipeStream(PipeDirection, Int32)Initializes a new instance of the PipeStream class using the specified PipeDirection value and buffer size.
Protected methodPipeStream(PipeDirection, PipeTransmissionMode, Int32)Initializes a new instance of the PipeStream class using the specified PipeDirection, PipeTransmissionMode, and buffer size.
Top

  NameDescription
Public propertyCanReadGets a value indicating whether the current stream supports read operations. (Overrides Stream.CanRead.)
Public propertyCanSeekGets a value indicating whether the current stream supports seek operations. (Overrides Stream.CanSeek.)
Public propertyCanTimeoutGets a value that determines whether the current stream can time out. (Inherited from Stream.)
Public propertyCanWriteGets a value indicating whether the current stream supports write operations. (Overrides Stream.CanWrite.)
Public propertyInBufferSizeGets the size, in bytes, of the inbound buffer for a pipe.
Public propertyIsAsyncGets a value indicating whether a PipeStream object was opened asynchronously or synchronously.
Public propertyIsConnectedGets or sets a value indicating whether a PipeStream object is connected.
Protected propertyIsHandleExposedGets a value indicating whether a handle to a PipeStream object is exposed.
Public propertyIsMessageCompleteGets a value indicating whether there is more data in the message returned from the most recent read operation.
Public propertyLengthGets the length of a stream, in bytes. (Overrides Stream.Length.)
Public propertyOutBufferSizeGets the size, in bytes, of the outbound buffer for a pipe.
Public propertyPositionGets or sets the current position of the current stream. (Overrides Stream.Position.)
Public propertyReadModeGets or sets the reading mode for a PipeStream object.
Public propertyReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
Public propertySafePipeHandleGets the safe handle for the local end of the pipe that the current PipeStream object encapsulates.
Public propertyTransmissionModeGets the pipe transmission mode supported by the current pipe.
Public propertyWriteTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)
Top

  NameDescription
Public methodBeginReadBegins an asynchronous read operation. (Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).)
Public methodBeginWriteBegins an asynchronous write operation. (Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)
Protected methodCheckPipePropertyOperationsInfrastructure. Verifies that the pipe is in a proper state for getting or setting properties.
Protected methodCheckReadOperationsInfrastructure. Verifies that the pipe is in a connected state for read operations.
Protected methodCheckWriteOperationsInfrastructure. Verifies that the pipe is in a connected state for write operations.
Public methodCloseCloses 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.)
Public methodCopyTo(Stream)Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodCopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.)
Public methodCopyToAsync(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.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Protected methodCreateWaitHandle Obsolete. Allocates a WaitHandle object. (Inherited from Stream.)
Public methodDispose()Releases all resources used by the Stream. (Inherited from Stream.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources. (Overrides Stream.Dispose(Boolean).)
Public methodEndReadEnds a pending asynchronous read request. (Overrides Stream.EndRead(IAsyncResult).)
Public methodEndWriteEnds a pending asynchronous write request. (Overrides Stream.EndWrite(IAsyncResult).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFlushClears the buffer for the current stream and causes any buffered data to be written to the underlying device. (Overrides Stream.Flush().)
Public methodFlushAsync()Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.)
Public methodFlushAsync(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.)
Public methodGetAccessControlGets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeHandleInitializes a PipeStream object from the specified SafePipeHandle object.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodObjectInvariantInfrastructure. Obsolete. Provides support for a Contract. (Inherited from Stream.)
Public methodReadReads a block of bytes from a stream and writes the data to a specified buffer. (Overrides Stream.Read(Byte[], Int32, Int32).)
Public methodReadAsync(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.)
Public methodReadAsync(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.)
Public methodReadByteReads a byte from a pipe. (Overrides Stream.ReadByte().)
Public methodSeekSets the current position of the current stream to the specified value. (Overrides Stream.Seek(Int64, SeekOrigin).)
Public methodSetAccessControlApplies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object.
Public methodSetLengthSets the length of the current stream to the specified value. (Overrides Stream.SetLength(Int64).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWaitForPipeDrainWaits for the other end of the pipe to read all sent bytes.
Public methodWriteWrites a block of bytes to the current stream using data from a buffer. (Overrides Stream.Write(Byte[], Int32, Int32).)
Public methodWriteAsync(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.)
Public methodWriteAsync(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.)
Public methodWriteByteWrites a byte to the current stream. (Overrides Stream.WriteByte(Byte).)
Top

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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • InheritanceDemand 

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

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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