org.apache.wicket.protocol.ws.api

Interface IWebSocketRequestHandler

All Superinterfaces:

org.apache.wicket.request.ILoggableRequestHandler, IPageClassRequestHandler, IPageRequestHandler, IPartialPageRequestHandler, org.apache.wicket.request.IRequestHandler

All Known Implementing Classes:

WebSocketRequestHandler

public interface IWebSocketRequestHandler
extends IPartialPageRequestHandler, org.apache.wicket.request.ILoggableRequestHandler

An interface for outbound communication with web socket clients

Since:

6.0

Method Summary

Methods

Modifier and Type	Method and 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.

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.core.request.handler.IPageRequestHandler

getPage, getPageId, getRenderCount, isPageInstanceCreated

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

getPageClass, getPageParameters

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

detach, respond

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

getLogData

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

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