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 サーバーでハブ メソッドを呼び出すために使用される接続。

メソッドの概要

修飾子と型	メソッドと説明
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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

param6 - 6 番目のパラメーター。

param7 - 7 番目のパラメーター。

param8 - 8 番目のパラメーター

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

param6 - 6 番目のパラメーター。

param7 - 7 番目のパラメーター。

param8 - 8 番目のパラメーター

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

param6 - 6 番目のパラメーター。

param7 - 7 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

param6 - 6 番目のパラメーター。

param7 - 7 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

param6 - 6 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

param6 - 6 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

param5 - 5 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

param4 - 4 番目のパラメーター。

Returns:

Subscriptionハブ メソッドの登録を解除するために破棄できる 。

<T1,T2,T3>on

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

指定したメソッド名を持つハブ メソッドが呼び出されたときに呼び出されるハンドラーを登録します。 プリミティブと非ジェネリック クラスに使用する必要があります。

Parameters:

target - 定義するハブ メソッドの名前。

callback - ハブ メソッドが呼び出されたときに発生するハンドラー。

param1 - 最初のパラメーター。

param2 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

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 - 2 番目のパラメーター。

param3 - 3 番目のパラメーター。

Returns:

Subscriptionハブ メソッドのサブスクライブを解除するために破棄できる 。

<T1,T2>on

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

指定したメソッド名を持つハブ メソッドが呼び出されたときに呼び出されるハンドラーを登録します。 プリミティブと非ジェネリック クラスに使用する必要があります。

Parameters:

target - 定義するハブ メソッドの名前。

callback - ハブ メソッドが呼び出されたときに発生するハンドラー。

param1 - 最初のパラメーター。

param2 - 2 番目のパラメーター。

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 - 2 番目のパラメーター。

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:

呼び出しが完了したときに戻り値を生成する単精度浮動小数点型 (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:

サーバーからのストリーミング結果を生成する監視可能な 。

close

public void close()

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:

呼び出しがいつ完了したかを示す Completedable。

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:

接続が確立されたときに完了する Completeable。

stop

public Completable stop()

サーバーへの接続を停止します。

Returns:

接続が停止されたときに完了する Completeable。