org.apache.wicket.protocol.ws
Interface IWebSocketSettings

All Known Implementing Classes:

WebSocketSettings

public interface IWebSocketSettings

Interface for websocket related settings.

More documentation is available about each setting in the setter method for the property.

Since:

6.4

Nested Class Summary

static class

IWebSocketSettings.Holder Holds this IWebSocketSettings in the Application's metadata.

Field Summary

static MetaDataKey<IWebSocketSettings>

KEY

Method Summary

IWebSocketConnectionRegistry	getConnectionRegistry()
Executor	getWebSocketPushMessageExecutor() The executor for processing websocket push messages broadcasted to all sessions.
IWebSocketSettings	setConnectionRegistry(IWebSocketConnectionRegistry connectionRegistry)
IWebSocketSettings	setWebSocketPushMessageExecutor(Executor executorService) Set the executor for processing websocket push messages broadcasted to all sessions.

Field Detail

KEY

static final MetaDataKey<IWebSocketSettings> KEY

Method Detail

getWebSocketPushMessageExecutor

Executor getWebSocketPushMessageExecutor()

The executor for processing websocket push messages broadcasted to all sessions.

Returns:

The executor used for processing push messages.

setWebSocketPushMessageExecutor

IWebSocketSettings setWebSocketPushMessageExecutor(Executor executorService)

Set the executor for processing websocket push messages broadcasted to all sessions. Default executor does all the processing in the caller thread. Using a proper thread pool is adviced for applications that send push events from ajax calls to avoid page level deadlocks.

Parameters:

executorService - The executor used for processing push messages.

getConnectionRegistry

IWebSocketConnectionRegistry getConnectionRegistry()

setConnectionRegistry

IWebSocketSettings setConnectionRegistry(IWebSocketConnectionRegistry connectionRegistry)