Интерфейс 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 в противном случае

Возвращает:

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

sendBinary

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

Параметры:

data - данные

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

Возвращает:

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

sendPing

CompletableFuture<WebSocket> sendPing(ByteBuffer message)

Параметры:

message - сообщение

Возвращает:

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

sendPong

CompletableFuture<WebSocket> sendPong(ByteBuffer message)

Параметры:

message - сообщение

Возвращает:

объект 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 - причина

Возвращает:

объект 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()