HubConnection 類別

套件:

com.microsoft.signalr

Maven 成品:

com.microsoft.signalr:signalr:5.0.10

• java.lang.Object
• • com.microsoft.signalr.HubConnection

實作

java.lang.AutoCloseable

public class HubConnection implements AutoCloseable

用來在 SignalR Server 上叫用中樞方法的連線。

方法摘要

修飾詞與類型	方法與描述
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() 取得連接連接 識別碼。
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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<T1,T2,T3>on

public Subscription on(String target, Action3 callback, Class param1, Class param2, Class param3)

註冊叫用具有指定方法名稱的中樞方法時，將會叫用的處理常式。 應該用於基本型別和非泛型類別。

Parameters:

target - 要定義的中樞方法名稱。

callback - 叫用中樞方法時所引發的處理常式。

param1 - 第一個參數。

param2 - 第二個參數。

param3 - 第三個參數。

Returns:

Subscription，可以處置以取消訂閱中樞方法。

<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:

Subscription，可以處置以取消訂閱中樞方法。

<T1,T2>on

public Subscription on(String target, Action2 callback, Class param1, Class param2)

註冊叫用具有指定方法名稱的中樞方法時，將會叫用的處理常式。 應該用於基本型別和非泛型類別。

Parameters:

target - 要定義的中樞方法名稱。

callback - 叫用中樞方法時所引發的處理常式。

param1 - 第一個參數。

param2 - 第二個參數。

Returns:

Subscription，可以處置以取消訂閱中樞方法。

<T1,T2>on

public Subscription on(String target, Action2 callback, Type param1, Type param2)

註冊叫用具有指定方法名稱的中樞方法時，將會叫用的處理常式。 應該用於泛型類別和參數化集合，例如 List 或 Map。 可以使用 擷取類型 TypeReference<T>

Parameters:

target - 要定義的中樞方法名稱。

callback - 叫用中樞方法時所引發的處理常式。

param1 - 第一個參數。

param2 - 第二個參數。

Returns:

Subscription，可以處置以取消訂閱中樞方法。

<T1>on

public Subscription on(String target, Action1 callback, Class param1)

註冊叫用具有指定方法名稱的中樞方法時，將會叫用的處理常式。 應該用於基本型別和非泛型類別。

Parameters:

target - 要定義的中樞方法名稱。

callback - 叫用中樞方法時所引發的處理常式。

param1 - 第一個參數。

Returns:

Subscription，可以處置以取消訂閱中樞方法。

<T1>on

public Subscription on(String target, Action1 callback, Type param1)

註冊叫用具有指定方法名稱的中樞方法時，將會叫用的處理常式。 應該用於泛型類別和參數化集合，例如 List 或 Map。 可以使用 擷取類型 TypeReference<T>

Parameters:

target - 要定義的中樞方法名稱。

callback - 叫用中樞方法時所引發的處理常式。

param1 - 第一個參數。

Returns:

Subscription，可以處置以取消訂閱中樞方法。

<T>invoke

public Single invoke(Class returnType, String method, Object[] args)

使用指定的方法名稱和引數，在伺服器上叫用中樞方法。

Parameters:

returnType - 預期的傳回型別。

method - 要叫用的伺服器方法名稱。

args - 用來叫用伺服器方法的引數。

Returns:

單一 ，會在叫用完成時產生傳回值。

<T>invoke

public Single invoke(Type returnType, String method, Object[] args)

使用指定的方法名稱和引數，在伺服器上叫用中樞方法。 可以使用 擷取類型 TypeReference<T>

Parameters:

returnType - 預期的傳回型別。

method - 要叫用的伺服器方法名稱。

args - 用來叫用伺服器方法的引數。

Returns:

單一 ，會在叫用完成時產生傳回值。

<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:

可觀察的 ，可產生來自伺服器的串流結果。

close

public void close()

getConnectionId

public String getConnectionId()

取得 connections 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:

Subscription，可以處置以取消訂閱中樞方法。

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:

建立連線時完成的可完成。

stop

public Completable stop()

停止與伺服器的連線。

Returns:

當連線停止時完成的可完成。