org.spincast.plugins.undertow.config

Interface ISpincastUndertowConfig

All Known Implementing Classes:

SpincastUndertowConfigDefault

public interface ISpincastUndertowConfig

Configurations for the Spincast Undertow plugin. We use "@ImplementedBy" to specify the default configurations to use if none is specified in a Guice module.

Method Summary

Modifier and Type	Method and Description
int	getWebsocketAutomaticPingIntervalSeconds() When the automatic WebSocket pings are enabled, this is the interval (in seconds) between two pings.
int	getWebsocketDefaultClosingCode() The default code to use when sending a "closing Websocket connection" event to a peer.
String	getWebsocketDefaultClosingReason() The default reason to use when sending a "closing Websocket connection" event to a peer.
String	getWebsocketPingMessageString() The ping text to use.
ThreadFactory	getWebsocketThreadExecutorForAppEventsThreadFactory() The ThreadFactory to use to create threads when sending WebSocket events to the application.
int	getWebsocketThreadExecutorForAppEventsThreadNumber() The maximum number of concurrent threads used when sending WebSocket events to the application.
int	getWebsocketThreadExecutorForAppEventsTimeoutAmount() The timeout amount before cancelling a task when sending WebSocket events to the application.
TimeUnit	getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit() The timeout TimeUnit before cancelling a task when sending WebSocket events to the application.
boolean	isWebsocketAutomaticPing() If true, pings will automatically be sent to peers of a WebSocket endpoint as an heartbeat.

Method Detail

isWebsocketAutomaticPing

boolean isWebsocketAutomaticPing()

If true, pings will automatically be sent to peers of a WebSocket endpoint as an heartbeat. Enabled by default.

getWebsocketAutomaticPingIntervalSeconds

int getWebsocketAutomaticPingIntervalSeconds()

When the automatic WebSocket pings are enabled, this is the interval (in seconds) between two pings. Defaults to 20 seconds.

getWebsocketPingMessageString

String getWebsocketPingMessageString()

The ping text to use. Must be < 125 characters. Defaults to "__ping"

getWebsocketDefaultClosingCode

int getWebsocketDefaultClosingCode()

The default code to use when sending a "closing Websocket connection" event to a peer. Valid codes can be found here Defaults to 1000, a normal closure.

getWebsocketDefaultClosingReason

String getWebsocketDefaultClosingReason()

The default reason to use when sending a "closing Websocket connection" event to a peer. Defaults to an empty message.

getWebsocketThreadExecutorForAppEventsThreadNumber

int getWebsocketThreadExecutorForAppEventsThreadNumber()

The maximum number of concurrent threads used when sending WebSocket events to the application. Defaults to 100.

getWebsocketThreadExecutorForAppEventsTimeoutAmount

int getWebsocketThreadExecutorForAppEventsTimeoutAmount()

The timeout amount before cancelling a task when sending WebSocket events to the application. Defaults to 60.

getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit

TimeUnit getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit()

The timeout TimeUnit before cancelling a task when sending WebSocket events to the application. Defaults to SECONDS.

getWebsocketThreadExecutorForAppEventsThreadFactory

ThreadFactory getWebsocketThreadExecutorForAppEventsThreadFactory()

The ThreadFactory to use to create threads when sending WebSocket events to the application. Defaults to null.