HubConnection 类
java.lang.Object
com.microsoft.signalr.HubConnection
实现
java.lang.AutoCloseable
public class HubConnection implements AutoCloseable
用于在 SignalR 服务器上调用中心方法的连接。
方法摘要
修饰符和类型
方法和描述
Subscription
<T1,T2,T3,T4,T5,T6,T7,T8>on(String target, Action8<T1,T2,T3,T4,T5,T6,T7,T8> callback, Class<T1> param1, Class<T2> param2, Class<T3> param3, Class<T4> param4, Class<T5> param5, Class<T6> param6, Class<T7> param7, Class<T8> param8)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5,T6,T7,T8>on(String target, Action8<T1,T2,T3,T4,T5,T6,T7,T8> callback, Type param1, Type param2, Type param3, Type param4, Type param5, Type param6, Type param7, Type param8)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5,T6,T7>on(String target, Action7<T1,T2,T3,T4,T5,T6,T7> callback, Class<T1> param1, Class<T2> param2, Class<T3> param3, Class<T4> param4, Class<T5> param5, Class<T6> param6, Class<T7> param7)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5,T6,T7>on(String target, Action7<T1,T2,T3,T4,T5,T6,T7> callback, Type param1, Type param2, Type param3, Type param4, Type param5, Type param6, Type param7)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5,T6>on(String target, Action6<T1,T2,T3,T4,T5,T6> callback, Class<T1> param1, Class<T2> param2, Class<T3> param3, Class<T4> param4, Class<T5> param5, Class<T6> param6)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5,T6>on(String target, Action6<T1,T2,T3,T4,T5,T6> callback, Type param1, Type param2, Type param3, Type param4, Type param5, Type param6)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5>on(String target, Action5<T1,T2,T3,T4,T5> callback, Class<T1> param1, Class<T2> param2, Class<T3> param3, Class<T4> param4, Class<T5> param5)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4,T5>on(String target, Action5<T1,T2,T3,T4,T5> callback, Type param1, Type param2, Type param3, Type param4, Type param5)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4>on(String target, Action4<T1,T2,T3,T4> callback, Class<T1> param1, Class<T2> param2, Class<T3> param3, Class<T4> param4)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3,T4>on(String target, Action4<T1,T2,T3,T4> callback, Type param1, Type param2, Type param3, Type param4)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3>on(String target, Action3<T1,T2,T3> callback, Class<T1> param1, Class<T2> param2, Class<T3> param3)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2,T3>on(String target, Action3<T1,T2,T3> callback, Type param1, Type param2, Type param3)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2>on(String target, Action2<T1,T2> callback, Class<T1> param1, Class<T2> param2)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1,T2>on(String target, Action2<T1,T2> callback, Type param1, Type param2)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1>on(String target, Action1<T1> callback, Class<T1> param1)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Subscription
<T1>on(String target, Action1<T1> callback, Type param1)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
io.reactivex.Single <T >
<T>invoke(Class<T> returnType, String method, Object[] args)
使用指定的方法名称和参数在服务器上调用中心方法。
io.reactivex.Single <T >
<T>invoke(Type returnType, String method, Object[] args)
使用指定的方法名称和参数在服务器上调用中心方法。
io.reactivex.Observable <T >
<T>stream(Class<T> returnType, String method, Object[] args)
使用指定的名称和参数在服务器上调用流式处理中心方法。
io.reactivex.Observable <T >
<T>stream(Type returnType, String method, Object[] args)
使用指定的名称和参数在服务器上调用流式处理中心方法。
void
close()
java.lang.String
getConnectionId()
获取连接连接ID。
HubConnectionState
getConnectionState()
指示服务器的状态 HubConnection 。
long
getKeepAliveInterval()
获取保持活动间隔。
long
getServerTimeout()
获取服务器超时持续时间。
io.reactivex.Completable
invoke(String method, Object[] args)
使用指定的方法名称和参数在服务器上调用中心方法。
Subscription
on(String target, Action callback)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
void
onClosed(OnClosedCallback callback)
注册一个回调,以在连接关闭时运行。
void
remove(String name)
删除与具有指定方法名称的方法关联的所有处理程序。
void
send(String method, Object[] args)
使用指定的方法名称在服务器上调用中心方法。
void
setBaseUrl(String url)
设置中心连接的新 URL。
void
setKeepAliveInterval(long keepAliveIntervalInMilliseconds)
设置保持活动间隔持续时间。
void
setServerTimeout(long serverTimeoutInMilliseconds)
设置连接的服务器超时间隔。
io.reactivex.Completable
start()
启动与服务器的连接。
io.reactivex.Completable
stop()
停止与服务器的连接。
继承成员
java.lang.Object.clone()
java.lang.Object.equals(java.lang.Object)
java.lang.Object.finalize()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long,int)
方法详细信息
<T1,T2,T3,T4,T5,T6,T7,T8>on
public Subscription on(String target, Action8 callback, Class param1, Class param2, Class param3, Class param4, Class param5, Class param6, Class param7, Class param8)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
param6
- 第六个参数。
param7
- 第七个参数。
param8
- 第八个参数
Returns:
<T1,T2,T3,T4,T5,T6,T7,T8>on
public Subscription on(String target, Action8 callback, Type param1, Type param2, Type param3, Type param4, Type param5, Type param6, Type param7, Type param8)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
param6
- 第六个参数。
param7
- 第七个参数。
param8
- 第八个参数
Returns:
<T1,T2,T3,T4,T5,T6,T7>on
public Subscription on(String target, Action7 callback, Class param1, Class param2, Class param3, Class param4, Class param5, Class param6, Class param7)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
param6
- 第六个参数。
param7
- 第七个参数。
Returns:
<T1,T2,T3,T4,T5,T6,T7>on
public Subscription on(String target, Action7 callback, Type param1, Type param2, Type param3, Type param4, Type param5, Type param6, Type param7)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
param6
- 第六个参数。
param7
- 第七个参数。
Returns:
<T1,T2,T3,T4,T5,T6>on
public Subscription on(String target, Action6 callback, Class param1, Class param2, Class param3, Class param4, Class param5, Class param6)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
param6
- 第六个参数。
Returns:
<T1,T2,T3,T4,T5,T6>on
public Subscription on(String target, Action6 callback, Type param1, Type param2, Type param3, Type param4, Type param5, Type param6)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
param6
- 第六个参数。
Returns:
<T1,T2,T3,T4,T5>on
public Subscription on(String target, Action5 callback, Class param1, Class param2, Class param3, Class param4, Class param5)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
Returns:
<T1,T2,T3,T4,T5>on
public Subscription on(String target, Action5 callback, Type param1, Type param2, Type param3, Type param4, Type param5)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
param5
- 第五个参数。
Returns:
<T1,T2,T3,T4>on
public Subscription on(String target, Action4 callback, Class param1, Class param2, Class param3, Class param4)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
Returns:
<T1,T2,T3,T4>on
public Subscription on(String target, Action4 callback, Type param1, Type param2, Type param3, Type param4)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
param4
- 第四个参数。
Returns:
<T1,T2,T3>on
public Subscription on(String target, Action3 callback, Class param1, Class param2, Class param3)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
Returns:
<T1,T2,T3>on
public Subscription on(String target, Action3 callback, Type param1, Type param2, Type param3)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
param3
- 第三个参数。
Returns:
<T1,T2>on
public Subscription on(String target, Action2 callback, Class param1, Class param2)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
Returns:
<T1,T2>on
public Subscription on(String target, Action2 callback, Type param1, Type param2)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
param2
- 第二个参数。
Returns:
<T1>on
public Subscription on(String target, Action1 callback, Class param1)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于基元和非泛型类。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
Returns:
<T1>on
public Subscription on(String target, Action1 callback, Type param1)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。 应用于泛型类和参数化集合,例如 List 或 Map。 可以使用 检索类型 TypeReference<T>
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
param1
- 第一个参数。
Returns:
<T>invoke
public Single invoke(Class returnType, String method, Object[] args)
使用指定的方法名称和参数在服务器上调用中心方法。
Parameters:
returnType
- 预期的返回类型。
method
- 要调用的服务器方法的名称。
args
- 用于调用服务器方法的参数。
Returns:
一个 Single,在调用完成时生成返回值。
<T>invoke
public Single invoke(Type returnType, String method, Object[] args)
使用指定的方法名称和参数在服务器上调用中心方法。 可以使用 检索类型 TypeReference<T>
Parameters:
returnType
- 预期的返回类型。
method
- 要调用的服务器方法的名称。
args
- 用于调用服务器方法的参数。
Returns:
一个 Single,在调用完成时生成返回值。
<T>stream
public Observable stream(Class returnType, String method, Object[] args)
使用指定的名称和参数在服务器上调用流式处理中心方法。
Parameters:
returnType
- 流项的预期返回类型。
method
- 要调用的服务器方法的名称。
args
- 用于调用服务器方法的参数。
Returns:
一个可观测值,可生成来自服务器的流式处理结果。
<T>stream
public Observable stream(Type returnType, String method, Object[] args)
使用指定的名称和参数在服务器上调用流式处理中心方法。
Parameters:
returnType
- 流项的预期返回类型。
method
- 要调用的服务器方法的名称。
args
- 用于调用服务器方法的参数。
Returns:
一个可观测值,可生成来自服务器的流式处理结果。
getConnectionId
public String getConnectionId()
获取 connectionId。 当连接停止时,此值将被清除,并且每次成功启动连接时都会有一个新值。
Returns:
表示客户端的 connectionId 的字符串。
getConnectionState
public HubConnectionState getConnectionState()
指示服务器的状态 HubConnection 。
Returns:
HubConnection 状态枚举。
getKeepAliveInterval
public long getKeepAliveInterval()
获取保持活动间隔。
Returns:
保持活动消息之间的间隔 (以毫秒为单位) 指定。
getServerTimeout
public long getServerTimeout()
获取服务器超时持续时间。
Returns:
服务器超时持续时间 (以毫秒) 指定。
invoke
public Completable invoke(String method, Object[] args)
使用指定的方法名称和参数在服务器上调用中心方法。
Parameters:
method
- 要调用的服务器方法的名称。
args
- 用于调用服务器方法的参数。
Returns:
一个可完成的 ,指示调用完成的时间。
on
public Subscription on(String target, Action callback)
注册在调用具有指定方法名称的中心方法时将调用的处理程序。
Parameters:
target
- 要定义的中心方法的名称。
callback
- 调用中心方法时将引发的处理程序。
Returns:
onClosed
public void onClosed(OnClosedCallback callback)
注册一个回调,以在连接关闭时运行。
Parameters:
callback
- 连接关闭时要运行的回调。
remove
public void remove(String name)
删除与具有指定方法名称的方法关联的所有处理程序。
Parameters:
name
- 要从中删除处理程序的中心方法的名称。
send
public void send(String method, Object[] args)
使用指定的方法名称在服务器上调用中心方法。 不等待接收方的响应。
Parameters:
method
- 要调用的服务器方法的名称。
args
- 要传递给方法的参数。
setBaseUrl
public void setBaseUrl(String url)
设置 HubConnection 的新 URL。
Parameters:
url
- 要连接到的 URL。
setKeepAliveInterval
public void setKeepAliveInterval(long keepAliveIntervalInMilliseconds)
设置保持活动间隔持续时间。
Parameters:
keepAliveIntervalInMilliseconds
- ) 连接应发送保持活动消息的时间间隔 (以毫秒为单位。
setServerTimeout
public void setServerTimeout(long serverTimeoutInMilliseconds)
设置连接的服务器超时间隔。
Parameters:
serverTimeoutInMilliseconds
- 服务器超时持续时间 (以毫秒) 指定。
start
public Completable start()
启动与服务器的连接。
Returns:
一个 Completeable,在建立连接后完成。
stop
public Completable stop()
停止与服务器的连接。
Returns:
连接已停止时完成的 Completeable。
适用于