io.javalin.websocket

Class WsHandler

java.lang.Object

io.javalin.websocket.WsHandler

public class WsHandler
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WsHandler()

Method Summary

Modifier and Type	Method and Description
void	onBinaryMessage(WsBinaryMessageHandler wsBinaryMessageHandler) Add a WsBinaryMessageHandler to the WsHandler.
void	onClose(WsCloseHandler wsCloseHandler) Add a WsCloseHandler to the WsHandler.
void	onConnect(WsConnectHandler wsConnectHandler) Add a WsConnectHandler to the WsHandler.
void	onError(WsErrorHandler wsErrorHandler) Add a wsErrorHandler to the WsHandler.
void	onMessage(WsMessageHandler wsMessageHandler) Add a WsMessageHandler to the WsHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsHandler

public WsHandler()

Method Detail

onConnect

public void onConnect(@NotNull
                      WsConnectHandler wsConnectHandler)

Add a WsConnectHandler to the WsHandler. The handler is called when a WebSocket client connects.

onMessage

public void onMessage(@NotNull
                      WsMessageHandler wsMessageHandler)

Add a WsMessageHandler to the WsHandler. The handler is called when a WebSocket client sends a String message.

onBinaryMessage

public void onBinaryMessage(@NotNull
                            WsBinaryMessageHandler wsBinaryMessageHandler)

Add a WsBinaryMessageHandler to the WsHandler. The handler is called when a WebSocket client sends a binary message.

onClose

public void onClose(@NotNull
                    WsCloseHandler wsCloseHandler)

Add a WsCloseHandler to the WsHandler. The handler is called when a WebSocket client closes the connection. The handler is not called in case of network issues, only when the client actively closes the connection (or times out).

onError

public void onError(@NotNull
                    WsErrorHandler wsErrorHandler)

Add a wsErrorHandler to the WsHandler. The handler is called when an error is detected.