PipeStream Class
Exposes a Stream object around a pipe, which supports both anonymous and named pipes.
Assembly: System.Core (in System.Core.dll)
The PipeStream type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | PipeStream(PipeDirection, Int32) | Initializes a new instance of the PipeStream class using the specified PipeDirection value and buffer size. |
![]() | PipeStream(PipeDirection, PipeTransmissionMode, Int32) | Initializes a new instance of the PipeStream class using the specified PipeDirection, PipeTransmissionMode, and buffer size. |
| Name | Description | |
|---|---|---|
![]() | CanRead | Gets a value indicating whether the current stream supports read operations. (Overrides Stream.CanRead.) |
![]() | CanSeek | Gets a value indicating whether the current stream supports seek operations. (Overrides Stream.CanSeek.) |
![]() | CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
![]() | CanWrite | Gets a value indicating whether the current stream supports write operations. (Overrides Stream.CanWrite.) |
![]() | InBufferSize | Gets the size, in bytes, of the inbound buffer for a pipe. |
![]() | IsAsync | Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously. |
![]() | IsConnected | Gets or sets a value indicating whether a PipeStream object is connected. |
![]() | IsHandleExposed | Gets a value indicating whether a handle to a PipeStream object is exposed. |
![]() | IsMessageComplete | Gets a value indicating whether there is more data in the message returned from the most recent read operation. |
![]() | Length | Gets the length of a stream, in bytes. (Overrides Stream.Length.) |
![]() | OutBufferSize | Gets the size, in bytes, of the outbound buffer for a pipe. |
![]() | Position | Gets or sets the current position of the current stream. (Overrides Stream.Position.) |
![]() | ReadMode | Gets or sets the reading mode for a PipeStream object. |
![]() | ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
![]() | SafePipeHandle | Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates. |
![]() | TransmissionMode | Gets the pipe transmission mode supported by the current pipe. |
![]() | WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
| Name | Description | |
|---|---|---|
![]() | BeginRead | Begins an asynchronous read operation. (Overrides Stream.BeginRead(Byte(), Int32, Int32, AsyncCallback, Object).) |
![]() | BeginWrite | Begins an asynchronous write operation. (Overrides Stream.BeginWrite(Byte(), Int32, Int32, AsyncCallback, Object).) |
![]() | CheckPipePropertyOperations | Infrastructure. Verifies that the pipe is in a proper state for getting or setting properties. |
![]() | CheckReadOperations | Infrastructure. Verifies that the pipe is in a connected state for read operations. |
![]() | CheckWriteOperations | Infrastructure. Verifies that the pipe is in a connected state for write operations. |
![]() | Close | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.) |
![]() | CopyTo(Stream) | Reads the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.) |
![]() | CopyTo(Stream, Int32) | Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (Inherited from Stream.) |
![]() | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
![]() | CreateWaitHandle | Obsolete. Allocates a WaitHandle object. (Inherited from Stream.) |
![]() | Dispose | Releases all resources used by the Stream. (Inherited from Stream.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources. (Overrides Stream.Dispose(Boolean).) |
![]() | EndRead | Ends a pending asynchronous read request. (Overrides Stream.EndRead(IAsyncResult).) |
![]() | EndWrite | Ends a pending asynchronous write request. (Overrides Stream.EndWrite(IAsyncResult).) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | Flush | Clears the buffer for the current stream and causes any buffered data to be written to the underlying device. (Overrides Stream.Flush.) |
![]() | GetAccessControl | Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InitializeHandle | Initializes a PipeStream object from the specified SafePipeHandle object. |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() | ObjectInvariant | Infrastructure. Provides support for a Contract. (Inherited from Stream.) |
![]() | Read | Reads a block of bytes from a stream and writes the data to a specified buffer. (Overrides Stream.Read(Byte(), Int32, Int32).) |
![]() | ReadByte | Reads a byte from a pipe. (Overrides Stream.ReadByte.) |
![]() | Seek | Sets the current position of the current stream to the specified value. (Overrides Stream.Seek(Int64, SeekOrigin).) |
![]() | SetAccessControl | Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object. |
![]() | SetLength | Sets the length of the current stream to the specified value. (Overrides Stream.SetLength(Int64).) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | WaitForPipeDrain | Waits for the other end of the pipe to read all sent bytes. |
![]() | Write | Writes a block of bytes to the current stream using data from a buffer. (Overrides Stream.Write(Byte(), Int32, Int32).) |
![]() | WriteByte | 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 Pipes. For an example of anonymous pipes, see How to: Use Anonymous Pipes to Communicate Between Local Processes. For an example of named pipes, see How to: Use Named Pipes to Communicate Between Processes over a Network.
Note |
|---|
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. |
- InheritanceDemand
for full trust for inheritors. This class cannot be inherited by partially trusted code.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
