PipeStream.ReadAsync 方法

定义

命名空间:

System.IO.Pipes

程序集:

System.IO.Pipes.dll

重载

ReadAsync(Memory<Byte>, CancellationToken)	从当前流异步读取字节的序列，将其写入字节内存范围，按读取的字节数向前移动流中的位置，并监视取消请求。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	从指定字节数的指定位置开始，将当前流中的字节序列异步读取到字节数组，按读取的字节数向前移动流中的位置，并监视取消请求。

ReadAsync(Memory<Byte>, CancellationToken)

Source:

PipeStream.Unix.cs

从当前流异步读取字节的序列，将其写入字节内存范围，按读取的字节数向前移动流中的位置，并监视取消请求。

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

参数

buffer

Memory<Byte>

要将数据写入的内存区域。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

ValueTask<Int32>

表示异步读取操作的任务。 其 Result 属性的值包含读入缓冲区的总字节数。 如果很多字节当前不可用，则结果值可小于在缓冲区中分配的字节数；如果已到达流结尾，则结果值可以为 0（零）。

例外

NotSupportedException

流不支持读取。

ObjectDisposedException

无法访问关闭的管道。

InvalidOperationException

管道尚未连接。

- 或 -

管道处于断开连接状态。

- 或 -

尚未设置管道句柄。 （你的 PipeStream 实现是否调用 InitializeHandle(SafePipeHandle, Boolean, Boolean)？

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

使用 ReadAsync 方法可以执行资源密集型 I/O 操作，而无需阻止main线程。 对于耗时的流操作可能会阻止 UI 线程并使应用看起来不工作的应用程序，此性能注意事项尤其重要。 异步方法与 async Visual Basic 和 C# 中的 和 await 关键字结合使用。

CanRead使用 属性确定当前实例是否支持读取。

如果在操作完成之前取消，则返回的任务将 TaskStatus.Canceled 包含 属性的值 Status 。

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

Source:

PipeStream.Unix.cs

从指定字节数的指定位置开始，将当前流中的字节序列异步读取到字节数组，按读取的字节数向前移动流中的位置，并监视取消请求。

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

参数

buffer

Byte[]

要写入数据的缓冲区。

offset

Int32

buffer 中的字节偏移量，从该偏移量开始写入从流中读取的数据。

count

Int32

最多读取的字节数。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

Task<Int32>

表示异步读取操作的任务。 其 Result 属性的值包含读入缓冲区的总字节数。 如果当前可用字节数少于所请求的字节数，则该结果值可小于所请求的字节数；如果已到达流结尾时，则为 0（零）。

例外

NotSupportedException

流不支持读取。

ObjectDisposedException

无法访问关闭的管道。

InvalidOperationException

管道尚未连接。

- 或 -

管道处于断开连接状态。

- 或 -

尚未设置管道句柄。 （你的 PipeStream 实现是否调用 InitializeHandle(SafePipeHandle, Boolean, Boolean)？

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

使用 ReadAsync 方法可以执行资源密集型 I/O 操作，而无需阻止main线程。 对于耗时的流操作可能会阻止 UI 线程并使应用看起来不工作的应用程序，此性能注意事项尤其重要。 异步方法与 async Visual Basic 和 C# 中的 和 await 关键字结合使用。

CanRead使用 属性确定当前实例是否支持读取。

如果在操作完成之前取消，则返回的任务将 TaskStatus.Canceled 包含 属性的值 Status 。

此方法存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Read(Byte[], Int32, Int32)异常。