org.jooby.spi

Interface NativeWebSocket

public interface NativeWebSocket

A web socket upgrade created from NativeRequest.upgrade(Class).

Since:

0.5.0

Author:

edgar

Method Summary

Modifier and Type	Method and Description
void	close(int status, String reason) Close the web socket.
boolean	isOpen()
void	onBinaryMessage(Consumer<ByteBuffer> callback) Set the onbinary message callback.
void	onCloseMessage(BiConsumer<Integer,Optional<String>> callback) Set the onclose message callback.
void	onConnect(Runnable callback) Set the onconnect callback.
void	onErrorMessage(Consumer<Throwable> callback) Set the onerror message callback.
void	onTextMessage(Consumer<String> callback) Set the ontext message callback.
void	pause() Pause reads.
void	resume() Resume reads.
void	sendBytes(byte[] data, WebSocket.SuccessCallback success, WebSocket.ErrCallback err) Send a binary message to the client.
void	sendBytes(ByteBuffer data, WebSocket.SuccessCallback success, WebSocket.ErrCallback err) Send a binary message to the client.
void	sendText(byte[] data, WebSocket.SuccessCallback success, WebSocket.ErrCallback err) Send a text message to the client.
void	sendText(ByteBuffer data, WebSocket.SuccessCallback success, WebSocket.ErrCallback err) Send a text message to the client.
void	sendText(String data, WebSocket.SuccessCallback success, WebSocket.ErrCallback err) Send a text message to the client.
void	terminate() Terminate immediately a connection.

Method Detail

close

void close(int status,
           String reason)

Close the web socket.

Parameters:

status - A web socket close status.

reason - A close reason.

resume

void resume()

Resume reads.

onConnect

void onConnect(Runnable callback)

Set the onconnect callback. It will be execute once per each client.

Parameters:

callback - A callback.

onTextMessage

void onTextMessage(Consumer<String> callback)

Set the ontext message callback. On message arrival the callback will be executed.

Parameters:

callback - A callback.

onBinaryMessage

void onBinaryMessage(Consumer<ByteBuffer> callback)

Set the onbinary message callback. On message arrival the callback will be executed.

Parameters:

callback - A callback.

onCloseMessage

void onCloseMessage(BiConsumer<Integer,Optional<String>> callback)

Set the onclose message callback. It will be executed when clients close a connection and/or connection idle timeout.

Parameters:

callback - A callback.

onErrorMessage

void onErrorMessage(Consumer<Throwable> callback)

Set the onerror message callback. It will be executed on errors.

Parameters:

callback - A callback.

pause

void pause()

Pause reads.

terminate

void terminate()
        throws IOException

Terminate immediately a connection.

Throws:

IOException - If termination fails.

sendBytes

void sendBytes(ByteBuffer data,
               WebSocket.SuccessCallback success,
               WebSocket.ErrCallback err)

Send a binary message to the client.

Parameters:

data - Message to send.

success - Success callback.

err - Error callback.

sendBytes

void sendBytes(byte[] data,
               WebSocket.SuccessCallback success,
               WebSocket.ErrCallback err)

Send a binary message to the client.

Parameters:

data - Message to send.

success - Success callback.

err - Error callback.

sendText

void sendText(String data,
              WebSocket.SuccessCallback success,
              WebSocket.ErrCallback err)

Send a text message to the client.

Parameters:

data - Message to send.

success - Success callback.

err - Error callback.

sendText

void sendText(ByteBuffer data,
              WebSocket.SuccessCallback success,
              WebSocket.ErrCallback err)

Send a text message to the client.

Parameters:

data - Message to send.

success - Success callback.

err - Error callback.

sendText

void sendText(byte[] data,
              WebSocket.SuccessCallback success,
              WebSocket.ErrCallback err)

Send a text message to the client.

Parameters:

data - Message to send.

success - Success callback.

err - Error callback.

isOpen

boolean isOpen()

Returns:

True if the websocket connection is open.