Package org.apache.wicket.protocol.ws.api

Interface IWebSocketProcessor

All Known Implementing Classes:

AbstractWebSocketProcessor, JavaxWebSocketProcessor

public interface IWebSocketProcessor

Processes web socket messages.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
void	onClose(int closeCode, String message)	A notification after the close of the web socket connection.
void	onError(Throwable t)	A notification after a communication error.
void	onMessage(byte[] data, int offset, int length)	Called when a binary message arrives from the client
void	onMessage(String message)	Called when a text message arrives from the client
void	onOpen(Object containerConnection)	A client successfully has made a web socket connection.
default void	onOpen(IWebSocketSession webSocketSession, WebApplication application)	Called when then IWebSocketSession is being opened: to allow to configure the underlying web socket session.

Method Detail

onOpen

default void onOpen(IWebSocketSession webSocketSession,
                    WebApplication application)

Called when then IWebSocketSession is being opened: to allow to configure the underlying web socket session.

Parameters:

webSocketSession - the IWebSocketSession

application - the WebApplication

onMessage

void onMessage(String message)

Called when a text message arrives from the client

Parameters:

message - the text message from the client

onMessage

void onMessage(byte[] data,
               int offset,
               int length)

Called when a binary message arrives from the client

Parameters:

data - the binary message from the client

offset - the offset to read from

length - how much data to read

onOpen

void onOpen(Object containerConnection)

A client successfully has made a web socket connection.

Parameters:

containerConnection - the web socket connection to use to communicate with the client

onClose

void onClose(int closeCode,
             String message)

A notification after the close of the web socket connection. The connection could be closed by either the client or the server

Parameters:

closeCode - The close code

message - the message

onError

void onError(Throwable t)

A notification after a communication error.

Parameters:

t - The throwable for the communication problem