io.jooby

Interface WebSocket

public interface WebSocket

Websocket. Usage:

     ws("/pattern", (ctx, configurer) -> {
       configurer.onConnect(ws -> {
         // Connect callback
       }):

       configurer.onMessage((ws, message) -> {
         ws.send("Got: " + message.value());
       });

       configurer.onClose((ws, closeStatus) -> {
         // Closing websocket
       });

       configurer.onError((ws, cause) -> {

       });
     });

 

NOTE: Websocket API ONLY handles text messages (not binary message).

Since:

2.2.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebSocket.Initializer Websocket initializer.
static interface	WebSocket.OnClose On close callback.
static interface	WebSocket.OnConnect On connect callback.
static interface	WebSocket.OnError On error callback.
static interface	WebSocket.OnMessage On message callback.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BUFFER_SIZE Max message size for websocket (13k).

Method Summary

Modifier and Type	Method and Description
default <T> T	attribute(String key) Get an attribute by his key.
default WebSocket	attribute(String key, Object value) Set an application attribute.
default WebSocket	close() Close the web socket and send a WebSocketCloseStatus.NORMAL code to client.
WebSocket	close(WebSocketCloseStatus closeStatus) Close the web socket and send a close status code to client.
default Map<String,Object>	getAttributes() Context attributes (a.k.a request attributes).
Context	getContext() Originating HTTP context.
List<WebSocket>	getSessions() Web sockets connected to the same path.
boolean	isOpen() True if websocket is open.
default WebSocket	render(Object value) Encode a value and send a text message to client.
WebSocket	render(Object value, boolean broadcast) Encode a value and send a text message to current client (broadcast = false) or to ALL connected clients under the websocket path (broadcast = true).
default WebSocket	send(byte[] message) Send a text message to client.
WebSocket	send(byte[] message, boolean broadcast) Send a text message to current client (broadcast = false) or to ALL connected clients under the websocket path (broadcast = true).
default WebSocket	send(String message) Send a text message to client.
WebSocket	send(String message, boolean broadcast) Send a text message to current client (broadcast = false) or to ALL connected clients under the websocket path (broadcast = true).

Field Detail

MAX_BUFFER_SIZE

static final int MAX_BUFFER_SIZE

Max message size for websocket (13k).

See Also:

Constant Field Values

Method Detail

getContext

@Nonnull
Context getContext()

Originating HTTP context. Please note this is a read-only context, so you are not allowed to modify or produces a response from it. The context let give you access to originating request (then one that was upgrade it).

Returns:

Read-only originating HTTP request.

getAttributes

@Nonnull
default Map<String,Object> getAttributes()

Context attributes (a.k.a request attributes).

Returns:

Context attributes.

attribute

@Nonnull
default <T> T attribute(@Nonnull
                                 String key)

Get an attribute by his key. This is just an utility method around getAttributes(). This method look first in current context and fallback to application attributes.

Type Parameters:

T - Attribute type.

Parameters:

key - Attribute key.

Returns:

Attribute value.

attribute

@Nonnull
default WebSocket attribute(@Nonnull
                                     String key,
                                     Object value)

Set an application attribute.

Parameters:

key - Attribute key.

value - Attribute value.

Returns:

This router.

send

@Nonnull
default WebSocket send(@Nonnull
                                String message)

Send a text message to client.

Parameters:

message - Text Message.

Returns:

This websocket.

getSessions

@Nonnull
List<WebSocket> getSessions()

Web sockets connected to the same path. This method doesn't include the current websocket.

Returns:

Web sockets or empty list.

isOpen

boolean isOpen()

True if websocket is open.

Returns:

True when open.

send

@Nonnull
WebSocket send(@Nonnull
                        String message,
                        boolean broadcast)

Send a text message to current client (broadcast = false) or to ALL connected clients under the websocket path (broadcast = true).

Parameters:

message - Text Message.

broadcast - True to send to all connected clients.

Returns:

This websocket.

send

@Nonnull
default WebSocket send(@Nonnull
                                byte[] message)

Send a text message to client.

Parameters:

message - Text Message.

Returns:

This websocket.

send

@Nonnull
WebSocket send(@Nonnull
                        byte[] message,
                        boolean broadcast)

Send a text message to current client (broadcast = false) or to ALL connected clients under the websocket path (broadcast = true).

Parameters:

message - Text Message.

broadcast - True to send to all connected clients.

Returns:

This websocket.

render

@Nonnull
default WebSocket render(@Nonnull
                                  Object value)

Encode a value and send a text message to client.

Parameters:

value - Value to send.

Returns:

This websocket.

render

@Nonnull
WebSocket render(@Nonnull
                          Object value,
                          boolean broadcast)

Encode a value and send a text message to current client (broadcast = false) or to ALL connected clients under the websocket path (broadcast = true).

Parameters:

value - Value to send.

broadcast - True to send to all connected clients.

Returns:

This websocket.

close

@Nonnull
default WebSocket close()

Close the web socket and send a WebSocketCloseStatus.NORMAL code to client. This method fires a WebSocket.OnClose.onClose(WebSocket, WebSocketCloseStatus) callback.

Returns:

This websocket.

close

@Nonnull
WebSocket close(@Nonnull
                         WebSocketCloseStatus closeStatus)

Close the web socket and send a close status code to client. This method fires a WebSocket.OnClose.onClose(WebSocket, WebSocketCloseStatus) callback.

Parameters:

closeStatus - Close status.

Returns:

This websocket.