org.jooby.internal.mvc

Class MvcWebSocket

java.lang.Object

org.jooby.internal.mvc.MvcWebSocket

All Implemented Interfaces:

WebSocket.Handler<Mutant>, WebSocket.OnClose, WebSocket.OnError, WebSocket.OnMessage<Mutant>, WebSocket.OnOpen

public class MvcWebSocket
extends Object
implements WebSocket.Handler<Mutant>

Method Summary

Modifier and Type	Method and Description
static WebSocket.OnOpen	newWebSocket(Class handler)
void	onClose(WebSocket.CloseStatus status)
void	onError(Throwable err) Invoked if something goes wrong.
void	onMessage(Mutant data) Invoked from a web socket.
void	onOpen(Request req, WebSocket ws) Inside a connect event, you can listen for WebSocket.onMessage(OnMessage), WebSocket.onClose(OnClose) or WebSocket.onError(OnError) events.

Methods inherited from class java.lang.Object

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

Method Detail

newWebSocket

public static WebSocket.OnOpen newWebSocket(Class handler)

onClose

public void onClose(WebSocket.CloseStatus status)
             throws Exception

Specified by:

onClose in interface WebSocket.OnClose

Throws:

Exception

onMessage

public void onMessage(Mutant data)
               throws Exception

Description copied from interface: WebSocket.OnMessage

Invoked from a web socket.

Specified by:

onMessage in interface WebSocket.OnMessage<Mutant>

Parameters:

data - Client message.

Throws:

Exception - If something goes wrong.

onError

public void onError(Throwable err)

Description copied from interface: WebSocket.OnError

Invoked if something goes wrong.

Specified by:

onError in interface WebSocket.OnError

Parameters:

err - Err cause.

onOpen

public void onOpen(Request req,
                   WebSocket ws)
            throws Exception

Description copied from interface: WebSocket.OnOpen

Inside a connect event, you can listen for WebSocket.onMessage(OnMessage), WebSocket.onClose(OnClose) or WebSocket.onError(OnError) events. Also, you can send text and binary message.

Specified by:

onOpen in interface WebSocket.OnOpen

Parameters:

req - Current request.

ws - A web socket.

Throws:

Exception - If something goes wrong while connecting.