Интерфейс WebSocket.Builder

Включающий интерфейс:: WebSocket

public static interface WebSocket.Builder

Построитель клиентов WebSocket.

Построители создаются путём вызова HttpClient.newWebSocketBuilder. Промежуточные (похожие на сеттеры) методы изменяют состояние построителя и возвращают тот же построитель, на котором они были вызваны. Если промежуточный метод не вызывается, предполагается соответствующее значение по умолчанию (или поведение). Построитель Builder не безопасен для использования в нескольких потоках без внешней синхронизации.

С тех пор:: 11

Методы

Модификатор и тип	Метод	Описание
`CompletableFuture<WebSocket>`	`buildAsync(URI uri, WebSocket.Listener listener)`	Создаёт `WebSocket`, подключённый к указанному `URI` и связанный с указанным `Listener`.
`WebSocket.Builder`	`connectTimeout(Duration timeout)`	Устанавливает таймаут для установления соединения WebSocket.
`WebSocket.Builder`	`header(String name, String value)`	Добавляет заданную пару имя-значение в список дополнительных HTTP-заголовков, отправляемых во время рукопожатия открытия.
`WebSocket.Builder`	`subprotocols(String mostPreferred, String... lesserPreferred)`	Устанавливает запрос для указанных субпротоколов.

Методы

WebSocket.Builder header(String name,
                         String value)

Добавляет заданную пару имя-значение в список дополнительных HTTP-заголовков, отправляемых во время рукопожатия открытия.

Заголовки, определённые в протоколе WebSocket, запрещены. Если этот метод не вызывается, дополнительные HTTP-заголовки не будут отправлены.

Параметры:: name — имя заголовка; value — значение заголовка
Возвращает:: этот построитель

connectTimeout

WebSocket.Builder connectTimeout(Duration timeout)

Устанавливает таймаут для установления соединения WebSocket.

Если соединение не будет установлено в течение указанного времени, создание WebSocket завершится с ошибкой HttpTimeoutException. Если этот метод не вызывается, предполагается бесконечный таймаут.

Параметры:: timeout — таймаут, неотрицательное, неравное нулю значение
Возвращает:: этот построитель

subprotocols

WebSocket.Builder subprotocols(String mostPreferred,
                               String... lesserPreferred)

Устанавливает запрос для указанных субпротоколов.

После того, как WebSocket был создан, фактический субпротокол можно получить с помощью WebSocket.getSubprotocol().

Субпротоколы указываются в порядке предпочтения. Наиболее предпочтительный субпротокол указывается первым. Если есть дополнительные субпротоколы, они перечисляются от наиболее предпочтительного к наименее предпочтительному.

Субпротоколы, не соответствующие синтаксису идентификаторов субпротоколов, запрещены. Если этот метод не вызывается, субпротоколы не будут запрошены.

Параметры:: mostPreferred — наиболее предпочтительный субпротокол; lesserPreferred — менее предпочтительные субпротоколы
Возвращает:: этот построитель

buildAsync

CompletableFuture<WebSocket> buildAsync(URI uri,
                                        WebSocket.Listener listener)

Создаёт WebSocket, подключённый к указанному URI и связанный с указанным Listener.

Возвращает CompletableFuture, которая либо завершится нормально с результирующим WebSocket, либо завершится с одной из следующих ошибок:

IOException — если произошла ошибка ввода-вывода
WebSocketHandshakeException — если рукопожатие открытия завершилось неудачно
HttpTimeoutException — если рукопожатие открытия не завершилось в течение таймаута
InterruptedException — если операция была прервана
SecurityException — если установлен менеджер безопасности и он запрещает access для uri. Проверки безопасности содержат дополнительную информацию, относящуюся к контексту безопасности, в котором вызывается слушатель.
IllegalArgumentException — если какой-либо из аргументов методов этого построителя некорректен

Параметры:: uri — URI WebSocket; listener — слушатель
Возвращает:: а CompletableFuture с WebSocket