HubConnection 类

定义

命名空间:

Microsoft.AspNetCore.SignalR.Client

程序集:

Microsoft.AspNetCore.SignalR.Client.Core.dll

包:

Microsoft.AspNetCore.SignalR.Client.Core v8.0.0

Source:

HubConnection.cs

用于在 SignalR 服务器上调用中心方法的连接。

public ref class HubConnection

public class HubConnection : IAsyncDisposable

type HubConnection = class
    interface IAsyncDisposable

Public Class HubConnection
Implements IAsyncDisposable

继承

Object

HubConnection

实现

IAsyncDisposable

注解

HubConnection应使用 HubConnectionBuilder创建 。 在调用中心方法之前，必须使用 启动 StartAsync(CancellationToken)连接。 使用 StopAsync(CancellationToken) 或 DisposeAsync()清理连接。

构造函数

HubConnection(IConnectionFactory, IHubProtocol, EndPoint, IServiceProvider, ILoggerFactory, IRetryPolicy)	初始化 HubConnection 类的新实例。
HubConnection(IConnectionFactory, IHubProtocol, EndPoint, IServiceProvider, ILoggerFactory)	初始化 HubConnection 类的新实例。

字段

DefaultHandshakeTimeout	默认超时，指定在关闭连接之前等待握手响应的时间。 默认为 15 秒。
DefaultKeepAliveInterval	客户端发送保持活动消息的默认时间间隔，让服务器知道不关闭连接。 默认值为 15 秒间隔。
DefaultServerTimeout	默认超时，指定在关闭连接之前等待消息的时间。 默认值为 30 秒。

属性

ConnectionId	获取连接的当前 ID。当连接停止时，此值将被清除，并且每次重新建立连接 () 时都会有一个新值。 如果通过 HttpConnectionOptions 跳过协商步骤，或者显式指定了 WebSocket 传输，则此值将为 null，因为客户端在这种情况下也会跳过协商。
HandshakeTimeout	获取或设置初始握手的超时时间。
KeepAliveInterval	获取或设置客户端发送 ping 消息的时间间隔。
ServerTimeout	获取或设置连接的服务器超时间隔。
State	指示服务器的状态 HubConnection 。

方法

DisposeAsync()	释放 HubConnection。
InvokeCoreAsync(String, Type, Object[], CancellationToken)	使用指定的方法名称、返回类型和参数调用服务器上的中心方法。
On(String, Type[], Func<Object[],Object,Task<Object>>, Object)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On(String, Type[], Func<Object[],Object,Task>, Object)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
Remove(String)	删除与具有指定方法名称的方法关联的所有处理程序。
SendCoreAsync(String, Object[], CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
StartAsync(CancellationToken)	启动与服务器的连接。
StopAsync(CancellationToken)	停止与服务器的连接。
StreamAsChannelCoreAsync(String, Type, Object[], CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsyncCore<TResult>(String, Object[], CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。

事件

Closed	关闭连接时发生。 连接可能由于错误或服务器或客户端有意关闭连接而未出错而关闭。
Reconnected	当 在失去其基础连接后成功重新连接时 HubConnection 发生。
Reconnecting	在 失去其基础连接后开始重新连接时 HubConnection 发生。

扩展方法

InvokeAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync(HubConnection, String, Object, CancellationToken)	使用指定的方法名称和参数调用服务器上的中心方法。
InvokeAsync(HubConnection, String, CancellationToken)	使用指定的方法名称在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeAsync<TResult>(HubConnection, String, Object, CancellationToken)	使用指定的方法名称和参数调用服务器上的中心方法。
InvokeAsync<TResult>(HubConnection, String, CancellationToken)	使用指定的方法名称在服务器上调用中心方法。
InvokeCoreAsync(HubConnection, String, Object[], CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
InvokeCoreAsync<TResult>(HubConnection, String, Object[], CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。
On(HubConnection, String, Action)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On(HubConnection, String, Func<Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On(HubConnection, String, Type[], Func<Object[],Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1>(HubConnection, String, Action<T1>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1>(HubConnection, String, Func<T1,Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<TResult>(HubConnection, String, Func<TResult>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<TResult>(HubConnection, String, Func<Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<TResult>(HubConnection, String, Type[], Func<Object[],Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2>(HubConnection, String, Action<T1,T2>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2>(HubConnection, String, Func<T1,T2,Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,TResult>(HubConnection, String, Func<T1,TResult>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,TResult>(HubConnection, String, Func<T1,Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3>(HubConnection, String, Action<T1,T2,T3>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3>(HubConnection, String, Func<T1,T2,T3,Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,TResult>(HubConnection, String, Func<T1,T2,TResult>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,TResult>(HubConnection, String, Func<T1,T2,Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4>(HubConnection, String, Action<T1,T2,T3,T4>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3,T4>(HubConnection, String, Func<T1,T2,T3,T4,Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3,TResult>(HubConnection, String, Func<T1,T2,T3,TResult>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,TResult>(HubConnection, String, Func<T1,T2,T3,Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5>(HubConnection, String, Action<T1,T2,T3,T4,T5>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3,T4,T5>(HubConnection, String, Func<T1,T2,T3,T4,T5,Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3,T4,TResult>(HubConnection, String, Func<T1,T2,T3,T4,TResult>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,TResult>(HubConnection, String, Func<T1,T2,T3,T4,Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6>(HubConnection, String, Action<T1,T2,T3,T4,T5,T6>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3,T4,T5,T6>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,Task>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。
On<T1,T2,T3,T4,T5,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,TResult>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,Task<TResult>>)	注册将在调用具有指定方法名称的中心方法时调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6,T7>(HubConnection, String, Action<T1,T2,T3,T4,T5,T6,T7>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。
On<T1,T2,T3,T4,T5,T6,T7>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,T7,Task>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。
On<T1,T2,T3,T4,T5,T6,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,TResult>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,Task<TResult>>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6,T7,T8>(HubConnection, String, Action<T1,T2,T3,T4,T5,T6,T7,T8>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。
On<T1,T2,T3,T4,T5,T6,T7,T8>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。
On<T1,T2,T3,T4,T5,T6,T7,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,T7,TResult>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6,T7,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,T7,Task<TResult>>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6,T7,T8,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
On<T1,T2,T3,T4,T5,T6,T7,T8,TResult>(HubConnection, String, Func<T1,T2,T3,T4,T5,T6,T7,T8,Task<TResult>>)	注册在调用具有指定方法名称的中心方法时将调用的处理程序。 如果服务器请求结果，则返回处理程序返回给服务器的值。
SendAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, Object, CancellationToken)	使用指定的方法名称和参数在服务器上调用中心方法。 不等待接收方的响应。
SendAsync(HubConnection, String, CancellationToken)	使用指定的方法名称在服务器上调用中心方法。 不等待接收方的响应。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsChannelAsync<TResult>(HubConnection, String, CancellationToken)	使用指定的方法名称和返回类型在服务器上调用流式处理中心方法。
StreamAsChannelCoreAsync<TResult>(HubConnection, String, Object[], CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, Object, CancellationToken)	使用指定的方法名称、返回类型和参数在服务器上调用流式处理中心方法。
StreamAsync<TResult>(HubConnection, String, CancellationToken)	使用指定的方法名称和返回类型在服务器上调用流式处理中心方法。