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

Вложенный интерфейс:: WebSocket

public static interface WebSocket.Builder

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

Построители создаются вызовом HttpClient.newWebSocketBuilder. Промежуточные (типа setter) методы изменяют состояние построителя и возвращают тот же построитель, на котором они были вызваны. Если промежуточный метод не вызывается, предполагается соответствующее значение по умолчанию (или поведение). Построитель 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, 2023, 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/21/docs/api/java.net.http/java/net/http/WebSocket.Builder.html