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() Возвращает идентификатор подключенияподключений.
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:

Объект 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:

Строка, представляющая идентификатор подключения клиента.

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:

Значение Completeable, указывающее, когда вызов завершен.

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)

Задает новый URL-адрес для HubConnection.

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, которое завершается после остановки подключения.