Интерфейс WebSocket

NORMAL_CLOSURE

static final int NORMAL_CLOSURE

См. также:

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

sendText

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

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

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

Параметры:

data - данные

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

Возвращает:

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

sendBinary

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

Параметры:

data - данные

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

Возвращает:

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

sendPing

CompletableFuture<WebSocket> sendPing(ByteBuffer message)

Параметры:

message - сообщение

Возвращает:

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

sendPong

CompletableFuture<WebSocket> sendPong(ByteBuffer message)

Параметры:

message - сообщение

Возвращает:

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

sendClose

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 - причина

Возвращает:

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

request

void request(long n)

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

Параметр этого метода - количество запрошенных вызовов от этого WebSocket к связанному слушателю, а не количество сообщений. Иногда сообщение может быть передано слушателю в одном вызове, но не всегда. Например, сообщения Ping, Pong и Close передаются в одном вызове методов onPing, onPong и onClose соответственно. Однако то, будут ли текстовые и двоичные сообщения переданы в одном вызове методов 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

getSubprotocol

String getSubprotocol()

Возвращает:

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

isOutputClosed

boolean isOutputClosed()

Возвращает:

true если закрыто, false в противном случае

isInputClosed

boolean isInputClosed()

Возвращает:

true если закрыт, false в противном случае

abort

void abort()