Интерфейс WebSocket

static final int NORMAL_CLOSURE

См. также:

• sendClose(int, String)
• WebSocket.Listener.onClose(WebSocket, int, String)
• Значения константных полей

CompletableFuture<WebSocket> sendText(CharSequence data, boolean last)

Примечание по реализации:

Если data является некорректной последовательностью UTF-16, операция завершится ошибкой IOException.

Параметры:

data — данные

last — true, если этот вызов завершает сообщение, иначе false

Возвращает:

CompletableFuture, выполнение которого завершается с этим WebSocket после отправки данных

CompletableFuture<WebSocket> sendBinary(ByteBuffer data, boolean last)

Параметры:

data — данные

last — true, если этот вызов завершает сообщение, иначе false

Возвращает:

CompletableFuture, выполнение которого завершается с этим WebSocket после отправки данных

CompletableFuture<WebSocket> sendPing(ByteBuffer message)

Параметры:

message — сообщение

Возвращает:

CompletableFuture, выполнение которого завершается с этим WebSocket после отправки сообщения Ping

CompletableFuture<WebSocket> sendPong(ByteBuffer message)

Параметры:

message — сообщение

Возвращает:

CompletableFuture, выполнение которого завершается с этим WebSocket после отправки сообщения Pong

CompletableFuture<WebSocket> sendClose(int statusCode, String reason)

Примечание к API:

В типичном случае используйте предоставленную целочисленную константу NORMAL_CLOSURE в качестве кода состояния и пустую строку в качестве причины:

     CompletableFuture<WebSocket> webSocket = ...
     webSocket.thenCompose(ws -> ws.sendText("Hello, ", false))
            .thenCompose(ws -> ws.sendText("world!", true))
            .thenCompose(ws -> ws.sendClose(WebSocket.NORMAL_CLOSURE, ""))
            .join();

Метод sendClose не закрывает вход этого WebSocket. Он лишь закрывает выход этого WebSocket, отправляя сообщение Close. Чтобы закрыть вход, вызовите метод abort. Ниже приведён пример приложения, которое отправляет сообщение Close, а затем запускает таймер. Если в течение указанного времени данные не поступят, таймер сработает, и сигнал тревоги прервёт WebSocket:

MyAlarm alarm = new MyAlarm(webSocket::abort);
WebSocket.Listener listener = new WebSocket.Listener() {

    public CompletionStage<?> onText(WebSocket webSocket,
                                     CharSequence data,
                                     boolean last) {
        alarm.snooze();
        ...
    }
    ...
};
...
Runnable startTimer = () -> {
    MyTimer idleTimer = new MyTimer();
    idleTimer.add(alarm, 30, TimeUnit.SECONDS);
};
webSocket.sendClose(WebSocket.NORMAL_CLOSURE, "ok").thenRun(startTimer);

Параметры:

statusCode — код состояния

reason — причина

Возвращает:

CompletableFuture, выполнение которого завершается с этим WebSocket после отправки сообщения Close

void request(long n)

Примечание к API:

Параметр этого метода — это количество запрашиваемых у данного WebSocket вызовов методов связанного слушателя, а не количество сообщений. Иногда сообщение может быть передано слушателю за один вызов, но так бывает не всегда. Например, сообщения Ping, Pong и Close передаются за один вызов методов onPing, onPong и onClose соответственно. Однако передача сообщений Text и Binary за один вызов методов onText и onBinary зависит от логического аргумента (last) этих методов. Если last имеет значение false, значит, сообщение передано не полностью.

Ниже приведён пример слушателя, который запрашивает вызовы по одному, пока не будет собрано полное сообщение, а затем обрабатывает результат:

    WebSocket.Listener listener = new WebSocket.Listener() {

    StringBuilder text = new StringBuilder();

    public CompletionStage<?> onText(WebSocket webSocket,
                                     CharSequence message,
                                     boolean last) {
        text.append(message);
        if (last) {
            processCompleteTextMessage(text);
            text = new StringBuilder();
        }
        webSocket.request(1);
        return null;
    }
};

Параметры:

n — количество вызовов

Выбрасывает:

IllegalArgumentException — если n <= 0

String getSubprotocol()

Возвращает:

подпротокол или пустую строку, если подпротокол отсутствует

boolean isOutputClosed()

Возвращает:

true, если выход закрыт; иначе false

boolean isInputClosed()

Возвращает:

true, если вход закрыт; иначе false

void abort()