一款简单易用的基础网络通讯组件库。

NamedPipeClientExtensionConnectAsyncTClient 方法

异步连接到指定的命名管道服务器

Definition

命名空间: TouchSocket.NamedPipe
程序集: TouchSocket.NamedPipe (在 TouchSocket.NamedPipe.dll 中) 版本:4.0.0-beta.143+5fcca7a4e70968794985dc3793adc50531308be6
C#
public static Task<TClient> ConnectAsync<TClient>(
	this TClient client,
	string pipeName,
	int millisecondsTimeout = 5000,
	CancellationToken cancellationToken = default
)
where TClient : INamedPipeClient

参数

client  TClient
命名管道客户端实例
pipeName  String
要连接的命名管道名称
millisecondsTimeout  Int32  (Optional)
连接超时时间(毫秒),默认为 5000ms
cancellationToken  CancellationToken  (Optional)
用于取消操作的取消令牌

类型参数

TClient
命名管道客户端类型,必须实现INamedPipeClient接口

返回值

TaskTClient
返回连接成功的客户端实例

备注

在 Visual Basic 和 C# 中,这个方法可以当成为类型 TClient 的实例方法来调用。在采用实例方法语法调用这个方法时,请省略第一个参数。请参考 扩展方法 (Visual Basic)扩展方法 (C# 编程指南) 获取更多信息。

异常

OperationCanceledException当连接操作被取消或超时时抛出
ArgumentNullException当 pipeName 为空时抛出
InvalidOperationException当客户端状态不允许连接时抛出

参见