PipeStream 类

定义

公开管道周围的 Stream 对象,该对象同时支持匿名管道和命名管道。Exposes a Stream object around a pipe, which supports both anonymous and named pipes.

public ref class PipeStream abstract : System::IO::Stream
public abstract class PipeStream : System.IO.Stream
type PipeStream = class
    inherit Stream
Public MustInherit Class PipeStream
Inherits Stream
继承
派生

注解

PipeStream 类为 .NET Framework 中的命名和匿名管道操作提供基类。The PipeStream class provides the base class for named and anonymous pipes operations in the .NET Framework. NamedPipeServerStreamNamedPipeClientStream 类用于命名管道操作。Use the NamedPipeServerStream and NamedPipeClientStream classes for named pipe operations. AnonymousPipeServerStreamAnonymousPipeClientStream 类用于匿名管道操作。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 for Local Interprocess Communication. 有关命名管道的示例,请参阅如何:使用命名管道进行网络进程间通信For an example of named pipes, see How to: Use Named Pipes for Network Interprocess Communication.

构造函数

PipeStream(PipeDirection, Int32)

使用指定的 PipeStream 值和缓冲区大小初始化 PipeDirection 类的一个新实例。Initializes a new instance of the PipeStream class using the specified PipeDirection value and buffer size.

PipeStream(PipeDirection, PipeTransmissionMode, Int32)

使用指定的 PipeStreamPipeDirection 和缓冲区大小初始化 PipeTransmissionMode 类的一个新实例。Initializes a new instance of the PipeStream class using the specified PipeDirection, PipeTransmissionMode, and buffer size.

属性

CanRead

获取一个值,该值指示当前流是否支持读操作。Gets a value indicating whether the current stream supports read operations.

CanSeek

获取一个值,该值指示当前流是否支持查找操作。Gets a value indicating whether the current stream supports seek operations.

CanTimeout

获取一个值,该值确定当前流是否可以超时。Gets a value that determines whether the current stream can time out.

(继承自 Stream)
CanWrite

获取一个值,该值指示当前流是否支持写操作。Gets a value indicating whether the current stream supports write operations.

InBufferSize

获取管道的入站缓冲区的大小(以字节为单位)。Gets the size, in bytes, of the inbound buffer for a pipe.

IsAsync

获取一个值,该值指示 PipeStream 对象是异步打开还是同步打开。Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously.

IsConnected

获取或设置一个值,该值指示是否已连接 PipeStream 对象。Gets or sets a value indicating whether a PipeStream object is connected.

IsHandleExposed

获取一个值,该值指示是否公开了 PipeStream 对象的句柄。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.

OutBufferSize

获取管道的出站缓冲区的大小(以字节为单位)。Gets the size, in bytes, of the outbound buffer for a pipe.

Position

获取或设置当前流的当前位置。Gets or sets the current position of the current stream.

ReadMode

获取或设置 PipeStream 对象的读取模式。Gets or sets the reading mode for a PipeStream object.

ReadTimeout

获取或设置一个值(以毫秒为单位),该值确定流在超时前尝试读取多长时间。Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

(继承自 Stream)
SafePipeHandle

获取当前 PipeStream 对象所封装的本地管道末端的安全句柄。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 milliseconds, that determines how long the stream will attempt to write before timing out.

(继承自 Stream)

方法

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

开始执行异步读取操作。Begins an asynchronous read operation.

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

开始执行异步写入操作。Begins an asynchronous write operation.

CheckPipePropertyOperations()

验证管道是否处于可供获取或设置属性的正确状态。Verifies that the pipe is in a proper state for getting or setting properties.

CheckReadOperations()

验证管道是否处于可供进行读操作的连接状态。Verifies that the pipe is in a connected state for read operations.

CheckWriteOperations()

验证管道是否处于可供进行写操作的连接状态。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. 不直接调用此方法,而应确保流得以正确释放。Instead of calling this method, ensure that the stream is properly disposed.

(继承自 Stream)
CopyTo(Stream)

从当前流中读取字节并将其写入到另一流中。Reads the bytes from the current stream and writes them to another stream.

(继承自 Stream)
CopyTo(Stream, Int32)

使用指定的缓冲区大小,从当前流中读取字节并将其写入到另一流中。Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

(继承自 Stream)
CopyToAsync(Stream)

从当前流中异步读取字节并将其写入到另一个流中。Asynchronously reads the bytes from the current stream and writes them to another stream.

(继承自 Stream)
CopyToAsync(Stream, CancellationToken)

通过指定的取消令牌,从当前流中异步读取字节并将其写入到另一个流中。Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token.

(继承自 Stream)
CopyToAsync(Stream, Int32)

使用指定的缓冲区大小,从当前流中异步读取字节并将其写入到另一流中。Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.

(继承自 Stream)
CopyToAsync(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.

(继承自 Stream)
CreateObjRef(Type)

创建一个对象,该对象包含生成用于与远程对象进行通信的代理所需的全部相关信息。Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(继承自 MarshalByRefObject)
CreateWaitHandle()

分配 WaitHandle 对象。Allocates a WaitHandle object.

(继承自 Stream)
Dispose()

释放由 Stream 使用的所有资源。Releases all resources used by the Stream.

(继承自 Stream)
Dispose(Boolean)

释放 PipeStream 类使用的非托管资源,并可以选择释放托管资源。Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources.

DisposeAsync()

异步释放 Stream 使用的非托管资源。Asynchronously releases the unmanaged resources used by the Stream.

(继承自 Stream)
EndRead(IAsyncResult)

结束挂起的异步读取请求。Ends a pending asynchronous read request.

EndWrite(IAsyncResult)

结束挂起的异步写入请求。Ends a pending asynchronous write request.

Equals(Object)

确定指定的对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
Flush()

清除当前流的缓冲区,并使所有缓冲的数据都写入到基础设备。Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.

FlushAsync()

异步清除此流的所有缓冲区并导致所有缓冲数据都写入基础设备中。Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.

(继承自 Stream)
FlushAsync(CancellationToken)

异步清理这个流的所有缓冲区,并使所有缓冲数据写入基础设备,并且监控取消请求。Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

(继承自 Stream)
GetAccessControl()

获取一个 PipeSecurity 对象,该对象封装当前 PipeStream 对象所描述管道的访问控制列表 (ACL) 项。Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object.

GetHashCode()

用作默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetLifetimeService()

检索控制此实例的生存期策略的当前生存期服务对象。Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(继承自 MarshalByRefObject)
GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
InitializeHandle(SafePipeHandle, Boolean, Boolean)

从指定的 PipeStream 对象中初始化 SafePipeHandle 对象。Initializes a PipeStream object from the specified SafePipeHandle object.

InitializeLifetimeService()

获取生存期服务对象来控制此实例的生存期策略。Obtains a lifetime service object to control the lifetime policy for this instance.

(继承自 MarshalByRefObject)
MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
MemberwiseClone(Boolean)

创建当前 MarshalByRefObject 对象的浅表副本。Creates a shallow copy of the current MarshalByRefObject object.

(继承自 MarshalByRefObject)
ObjectInvariant()

提供对 Contract 的支持。Provides support for a Contract.

(继承自 Stream)
Read(Byte[], Int32, Int32)

从指定长度的指定位置开始,从流中读取一个字节块,并将数据写入指定的缓冲区。Reads a block of bytes from a stream and writes the data to a specified buffer starting at a specified position for a specified length.

Read(Span<Byte>)

从当前流中读取一个字节序列,将其写入字节数组,并按读取的字节数向前移动流中的位置。Reads a sequence of bytes from the current stream, writes them to a byte array, and advances the position within the stream by the number of bytes read.

ReadAsync(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.

(继承自 Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)

从指定字节数的指定位置开始,将当前流中的字节序列异步读取到字节数组,按读取的字节数向前移动流中的位置,并监视取消请求。Asynchronously reads a sequence of bytes from the current stream to a byte array starting at a specified position for a specified number of bytes, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken)

从当前流异步读取字节的序列,将其写入字节内存范围,按读取的字节数向前移动流中的位置,并监视取消请求。Asynchronously reads a sequence of bytes from the current stream, writes them to a byte memory range, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

ReadByte()

从管道读取字节。Reads a byte from a pipe.

Seek(Int64, SeekOrigin)

将当前流的当前位置设置为指定值。Sets the current position of the current stream to the specified value.

SetAccessControl(PipeSecurity)

PipeSecurity 对象所指定的访问控制列表 (ACL) 项应用于由当前 PipeStream 对象指定的管道。Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object.

SetLength(Int64)

将当前流的长度设为指定值。Sets the length of the current stream to the specified value.

ToString()

返回一个表示当前对象的 string。Returns a string that represents the current object.

(继承自 Object)
WaitForPipeDrain()

等待管道另一端读取所有发送的字节。Waits for the other end of the pipe to read all sent bytes.

Write(Byte[], Int32, Int32)

使用缓冲区中的数据将字节块写入当前流。Writes a block of bytes to the current stream using data from a buffer.

Write(ReadOnlySpan<Byte>)

将字节序列写入当前流,并按写入的字节数向前调整流的当前位置。Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

WriteAsync(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.

(继承自 Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)

从字节数组的指定位置开始异步写入指定字节数,按写入的字节数向前移动此流中的当前位置,并监视取消请求。Asynchronously writes a specified number of bytes from a byte array starting at a specified position, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.

WriteAsync(ReadOnlyMemory<Byte>, 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.

WriteByte(Byte)

将字节写入当前流。Writes a byte to the current stream.

显式界面实现

IDisposable.Dispose()

释放由 Stream 使用的所有资源。Releases all resources used by the Stream.

(继承自 Stream)

扩展方法

GetAccessControl(PipeStream)
SetAccessControl(PipeStream, PipeSecurity)

安全性

InheritanceDemand
完全信任继承者。for full trust for inheritors. 此类不能由部分信任的代码继承。This class cannot be inherited by partially trusted code.

适用于