NamedPipeServerStream.WaitForConnectionAsync 方法

定义

命名空间:

System.IO.Pipes

程序集:

System.IO.Pipes.dll

异步等待客户端连接到该 NamedPipeServerStream 对象。

重载

WaitForConnectionAsync()	异步等待客户端连接到该 NamedPipeServerStream 对象。
WaitForConnectionAsync(CancellationToken)	异步等待客户端连接到此 NamedPipeServerStream 对象并监视取消请求。

WaitForConnectionAsync()

Source:

NamedPipeServerStream.cs

异步等待客户端连接到该 NamedPipeServerStream 对象。

public:
 System::Threading::Tasks::Task ^ WaitForConnectionAsync();

public System.Threading.Tasks.Task WaitForConnectionAsync ();

member this.WaitForConnectionAsync : unit -> System.Threading.Tasks.Task

Public Function WaitForConnectionAsync () As Task

返回

Task

表示异步等待操作的任务。

注解

由于此方法是异步的，因此会立即返回 ，但连接过程在客户端调用 Connect 或 ConnectAsync时完成。

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

WaitForConnectionAsync(CancellationToken)

Source:

NamedPipeServerStream.Unix.cs

异步等待客户端连接到此 NamedPipeServerStream 对象并监视取消请求。

public:
 System::Threading::Tasks::Task ^ WaitForConnectionAsync(System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task WaitForConnectionAsync (System.Threading.CancellationToken cancellationToken);

member this.WaitForConnectionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function WaitForConnectionAsync (cancellationToken As CancellationToken) As Task

参数

cancellationToken

CancellationToken

要监视取消请求的标记。

返回

Task

表示异步等待操作的任务。

例外

OperationCanceledException

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

注解

由于此方法是异步的，因此会立即返回 ，但连接过程在客户端调用 Connect 或 ConnectAsync时完成。

仅当 NamedPipeServerStream 对象是使用管道选项值 PipeOptions.Asynchronous 创建的，或者如果在调用 方法之前取消，则使用取消令牌的 WaitForConnectionAsync 取消请求才起作用。

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