SpincastUndertowConfig (org.spincast:spincast-framework 0.9.34 API)

All Known Implementing Classes:

SpincastUndertowConfigDefault
```
public interface SpincastUndertowConfig
```
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getHtmlFormEncoding()` The encoding the use to parse the data from HTML forms.
`int`	`getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()` The number of milliseconds to sleep between two validations that all endpoints are closed properly before calling the killing server.stop() method.
`int`	`getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()` The number of seconds max to wait for all endpoints to be closed properly before calling the killing server.stop() method.
`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.
  - getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer
```
int getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()
```
    The number of seconds max to wait for all endpoints to be closed properly before calling the killing server.stop() method.
  - getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer
```
int getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()
```
    The number of milliseconds to sleep between two validations that all endpoints are closed properly before calling the killing server.stop() method.
  - getHtmlFormEncoding
```
String getHtmlFormEncoding()
```
    The encoding the use to parse the data from HTML forms. Default to UTF-8.

Interface SpincastUndertowConfig

Method Summary

Method Detail

isWebsocketAutomaticPing

getWebsocketAutomaticPingIntervalSeconds

getWebsocketPingMessageString

getWebsocketDefaultClosingCode

getWebsocketDefaultClosingReason

getWebsocketThreadExecutorForAppEventsThreadNumber

getWebsocketThreadExecutorForAppEventsTimeoutAmount

getWebsocketThreadExecutorForAppEventsTimeoutTimeUnit

getWebsocketThreadExecutorForAppEventsThreadFactory

getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer

getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer

getHtmlFormEncoding