Интерфейс 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 — время ожидания, неотрицательное, не-отрицательное, не-ZERO
Возвращает:: этот построитель

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://docs.oracle.com/en/java/javase/25/docs/api/java.net.http/java/net/http/WebSocket.Builder.html