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

Interface IWebSocketRequestHandler

All Superinterfaces:

ILoggableRequestHandler, IPageClassRequestHandler, IPageRequestHandler, IPartialPageRequestHandler, IRequestHandler

All Known Implementing Classes:

WebSocketRequestHandler

public interface IWebSocketRequestHandler
extends IPartialPageRequestHandler, ILoggableRequestHandler

An interface for outbound communication with web socket clients

Since:

6.0

Method Summary

Modifier and Type	Method	Description
void	push(byte[] message, int offset, int length)	Pushes a binary message to the client.
void	push(CharSequence message)	Pushes a text message to the client.
Future<Void>	pushAsync(byte[] message, int offset, int length)	Pushes a binary message to the client.
Future<Void>	pushAsync(byte[] message, int offset, int length, long timeout)	Pushes a binary message to the client.
Future<Void>	pushAsync(CharSequence message)	Pushes a text message to the client in an asynchronous way.
Future<Void>	pushAsync(CharSequence message, long timeout)	Pushes a text message to the client in an asynchronous way.

Methods inherited from interface org.apache.wicket.request.ILoggableRequestHandler

getLogData

Methods inherited from interface org.apache.wicket.core.request.handler.IPageClassRequestHandler

getPageClass, getPageParameters

Methods inherited from interface org.apache.wicket.core.request.handler.IPageRequestHandler

getPage, getPageId, getRenderCount, isPageInstanceCreated

Methods inherited from interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

add, add, addChildren, appendJavaScript, focusComponent, getComponents, getHeaderResponse, prependJavaScript

Methods inherited from interface org.apache.wicket.request.IRequestHandler

detach, respond

Method Detail

push

void push(CharSequence message)

Pushes a text message to the client.

Parameters:

message - the text message to push to the client if the web socket connection is open

pushAsync

Future<Void> pushAsync(CharSequence message)

Pushes a text message to the client in an asynchronous way.

Parameters:

message - the text message to push to the client if the web socket connection is open

Returns:

a Future representing the send operation. Or null if connection is closed.

pushAsync

Future<Void> pushAsync(CharSequence message,
                       long timeout)

Pushes a text message to the client in an asynchronous way.

Parameters:

message - the text message to push to the client if the web socket connection is open

timeout - the timeout for operation

Returns:

a Future representing the send operation. Or null if connection is closed.

push

void push(byte[] message,
          int offset,
          int length)

Pushes a binary message to the client.

Parameters:

message - the binary message to push to the client if the web socket connection is open

offset - the offset to start to read from the message

length - how many bytes to read from the message

pushAsync

Future<Void> pushAsync(byte[] message,
                       int offset,
                       int length)

Pushes a binary message to the client.

Parameters:

message - the binary message to push to the client if the web socket connection is open

offset - the offset to start to read from the message

length - how many bytes to read from the message

Returns:

a Future representing the send operation. Or null if connection is closed.

pushAsync

Future<Void> pushAsync(byte[] message,
                       int offset,
                       int length,
                       long timeout)

Pushes a binary message to the client.

Parameters:

message - the binary message to push to the client if the web socket connection is open

offset - the offset to start to read from the message

length - how many bytes to read from the message

timeout - the timeout for operation

Returns:

a Future representing the send operation. Or null if connection is closed.