Интерфейс 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)`	Устанавливает запрос для указанных субпротоколов.

Подробное описание методов

header

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 - слушатель
Возвращает:: a CompletableFuture с WebSocket

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.net.http/java/net/http/WebSocket.Builder.html