com.github.peterbencze.serritor.internal.web.socket

Class WebSocketHandlerWrapper

java.lang.Object

com.github.peterbencze.serritor.internal.web.socket.WebSocketHandlerWrapper

@WebSocket
public final class WebSocketHandlerWrapper
extends Object

A WebSocket handler wrapper that notifies the WebSocket session manager when a client connects or disconnects and also delegates the handling of the event to the user defined handler.

Constructor Summary

Constructors

Constructor and Description
WebSocketHandlerWrapper(WebSocketSessionManager sessionManager, WebSocketHandler delegateHandler) Creates a WebSocketHandlerWrapper instance.

Method Summary

Modifier and Type	Method and Description
void	onWebSocketBinary(org.eclipse.jetty.websocket.api.Session session, byte[] payload, int offset, int length) Called when a client sends a binary message.
void	onWebSocketClose(org.eclipse.jetty.websocket.api.Session session, int statusCode, String reason) Called when a client disconnects.
void	onWebSocketConnect(org.eclipse.jetty.websocket.api.Session session) Called when a client connects.
void	onWebSocketError(org.eclipse.jetty.websocket.api.Session session, Throwable cause) Called when a WebSocket error occurs.
void	onWebSocketText(org.eclipse.jetty.websocket.api.Session session, String message) Called when a client sends a text message.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketHandlerWrapper

public WebSocketHandlerWrapper(WebSocketSessionManager sessionManager,
                               WebSocketHandler delegateHandler)

Creates a WebSocketHandlerWrapper instance.

Parameters:

sessionManager - the session manager which tracks the currently open WebSocket sessions

delegateHandler - the user defined handler which actually handles the event

Method Detail

onWebSocketConnect

@OnWebSocketConnect
public void onWebSocketConnect(org.eclipse.jetty.websocket.api.Session session)
                                             throws IOException

Called when a client connects.

Parameters:

session - the WebSocket session

Throws:

IOException - if an I/O error occurs in the handler

onWebSocketText

@OnWebSocketMessage
public void onWebSocketText(org.eclipse.jetty.websocket.api.Session session,
                                                 String message)
                                          throws IOException

Called when a client sends a text message.

Parameters:

session - the WebSocket session

message - the message

Throws:

IOException - if an I/O error occurs in the handler

onWebSocketBinary

@OnWebSocketMessage
public void onWebSocketBinary(org.eclipse.jetty.websocket.api.Session session,
                                                   byte[] payload,
                                                   int offset,
                                                   int length)
                                            throws IOException

Called when a client sends a binary message.

Parameters:

session - the WebSocket session

payload - the raw payload array

offset - the offset in the payload array where the data starts

length - the length of bytes in the payload

Throws:

IOException - if an I/O error occurs in the handler

onWebSocketClose

@OnWebSocketClose
public void onWebSocketClose(org.eclipse.jetty.websocket.api.Session session,
                                                int statusCode,
                                                String reason)
                                         throws IOException

Called when a client disconnects.

Parameters:

session - the WebSocket session

statusCode - the close status code

reason - the optional reason for the close

Throws:

IOException - if an I/O error occurs in the handler

onWebSocketError

@OnWebSocketError
public void onWebSocketError(org.eclipse.jetty.websocket.api.Session session,
                                                Throwable cause)
                                         throws IOException

Called when a WebSocket error occurs.

Parameters:

session - the WebSocket session

cause - the cause of the error

Throws:

IOException - if an I/O error occurs in the handler