Интерфейс 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()