org.jooby.internal

Class WebSocketImpl

java.lang.Object

org.jooby.internal.WebSocketImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Registry, WebSocket

public class WebSocketImpl
extends Object
implements WebSocket

Nested Class Summary

Nested classes/interfaces inherited from interface org.jooby.WebSocket

WebSocket.CloseStatus, WebSocket.Definition, WebSocket.Handler<T>, WebSocket.OnClose, WebSocket.OnError, WebSocket.OnMessage<T>, WebSocket.OnOpen, WebSocket.OnOpen1, WebSocket.SuccessCallback

Field Summary

Fields inherited from interface org.jooby.WebSocket

BAD_DATA, ERR, GOING_AWAY, KEY, NORMAL, NOT_ACCEPTABLE, POLICY_VIOLATION, PROTOCOL_ERROR, REQUIRED_EXTENSION, SERVER_ERROR, SERVICE_OVERLOAD, SERVICE_RESTARTED, SUCCESS, TOO_BIG_TO_PROCESS

Constructor Summary

Constructors

Constructor and Description
WebSocketImpl(WebSocket.OnOpen handler, String path, String pattern, Map<Object,String> vars, MediaType consumes, MediaType produces)

Method Summary

Modifier and Type	Method and Description
void	broadcast(Object data, WebSocket.SuccessCallback success, WebSocket.OnError err) Send data to all connected sessions.
void	close(WebSocket.CloseStatus status) Gracefully closes the connection, after sending a description message
void	connect(com.google.inject.Injector injector, Request req, NativeWebSocket ws)
MediaType	consumes()
boolean	isOpen() True if the websocket is still open.
void	onClose(WebSocket.OnClose callback) Register an close callback to execute when client close the web socket.
void	onError(WebSocket.OnError callback) Register an error callback to execute when an error is found.
void	onMessage(WebSocket.OnMessage<Mutant> callback) Register a callback to execute when a new message arrive.
String	path()
String	pattern()
void	pause() Pause the client stream.
MediaType	produces()
<T> T	require(com.google.inject.Key<T> key) Request a service of the given key.
void	resume() Resume the client stream.
void	send(Object data, WebSocket.SuccessCallback success, WebSocket.OnError err) Send data through the connection.
void	terminate() Immediately shuts down the connection.
String	toString()
Map<Object,String>	vars()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jooby.WebSocket

broadcast, broadcast, broadcast, close, close, close, send, send, send

Methods inherited from interface org.jooby.Registry

require, require, require

Constructor Detail

WebSocketImpl

public WebSocketImpl(WebSocket.OnOpen handler,
                     String path,
                     String pattern,
                     Map<Object,String> vars,
                     MediaType consumes,
                     MediaType produces)

Method Detail

close

public void close(WebSocket.CloseStatus status)

Description copied from interface: WebSocket

Gracefully closes the connection, after sending a description message

Specified by:

close in interface WebSocket

Parameters:

status - Close status code.

resume

public void resume()

Description copied from interface: WebSocket

Resume the client stream.

Specified by:

resume in interface WebSocket

pause

public void pause()

Description copied from interface: WebSocket

Pause the client stream.

Specified by:

pause in interface WebSocket

terminate

public void terminate()
               throws Exception

Description copied from interface: WebSocket

Immediately shuts down the connection.

Specified by:

terminate in interface WebSocket

Throws:

Exception - If something goes wrong.

isOpen

public boolean isOpen()

Description copied from interface: WebSocket

True if the websocket is still open.

Specified by:

isOpen in interface WebSocket

Returns:

True if the websocket is still open.

broadcast

public void broadcast(Object data,
                      WebSocket.SuccessCallback success,
                      WebSocket.OnError err)
               throws Exception

Description copied from interface: WebSocket

Send data to all connected sessions. If the web socket is closed this method throw an Err with WebSocket.NORMAL close status.

Specified by:

broadcast in interface WebSocket

Parameters:

data - Data to send.

success - A success callback.

err - An err callback.

Throws:

Exception - If something goes wrong.

send

public void send(Object data,
                 WebSocket.SuccessCallback success,
                 WebSocket.OnError err)
          throws Exception

Description copied from interface: WebSocket

Send data through the connection. If the web socket is closed this method throw an Err with WebSocket.NORMAL close status.

Specified by:

send in interface WebSocket

Parameters:

data - Data to send.

success - A success callback.

err - An err callback.

Throws:

Exception - If something goes wrong.

onMessage

public void onMessage(WebSocket.OnMessage<Mutant> callback)
               throws Exception

Description copied from interface: WebSocket

Register a callback to execute when a new message arrive.

Specified by:

onMessage in interface WebSocket

Parameters:

callback - A callback

Throws:

Exception - If something goes wrong.

connect

public void connect(com.google.inject.Injector injector,
                    Request req,
                    NativeWebSocket ws)

path

public String path()

Specified by:

path in interface WebSocket

Returns:

Current request path.

pattern

public String pattern()

Specified by:

pattern in interface WebSocket

Returns:

The currently matched pattern.

vars

public Map<Object,String> vars()

Specified by:

vars in interface WebSocket

Returns:

The currently matched path variables (if any).

consumes

public MediaType consumes()

Specified by:

consumes in interface WebSocket

Returns:

The type this route can consumes, defaults is: * / *.

produces

public MediaType produces()

Specified by:

produces in interface WebSocket

Returns:

The type this route can produces, defaults is: * / *.

require

public <T> T require(com.google.inject.Key<T> key)

Description copied from interface: Registry

Request a service of the given key.

Specified by:

require in interface Registry

Type Parameters:

T - Service type.

Parameters:

key - A service key.

Returns:

A ready to use object.

toString

public String toString()

Overrides:

toString in class Object

onError

public void onError(WebSocket.OnError callback)

Description copied from interface: WebSocket

Register an error callback to execute when an error is found.

Specified by:

onError in interface WebSocket

Parameters:

callback - A callback

onClose

public void onClose(WebSocket.OnClose callback)
             throws Exception

Description copied from interface: WebSocket

Register an close callback to execute when client close the web socket.

Specified by:

onClose in interface WebSocket

Parameters:

callback - A callback

Throws:

Exception - If something goes wrong.