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

Окружающий интерфейс:: WebSocket

public static interface WebSocket.Builder

Создатель клиентов WebSocket.

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

С:: 11

Краткое описание методов

Модификатор и тип	Метод	Описание
`CompletableFuture<WebSocket>`	`buildAsync(URI uri, WebSocket.Listener listener)`	Создает подключенное к заданному `URI` и связанное с заданным `Listener` `WebSocket`.
`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 - если операция прервана
IllegalArgumentException - если какой-либо из аргументов методов этого создателя является недопустимым

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

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.net.http/java/net/http/WebSocket.Builder.html