org.spincast.plugins.httpclient.websocket

Class SpincastHttpClientWithWebsocketConfigDefault

java.lang.Object

org.spincast.plugins.httpclient.SpincastHttpClientConfigDefault

org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault

All Implemented Interfaces:

ISpincastHttpClientConfig, ISpincastHttpClientWithWebsocketConfig

public class SpincastHttpClientWithWebsocketConfigDefault
extends SpincastHttpClientConfigDefault
implements ISpincastHttpClientWithWebsocketConfig

Default configurations for the Spincast Http Client with Websocket support plugin.

Constructor Summary

Constructors

Constructor and Description
SpincastHttpClientWithWebsocketConfigDefault()

Method Summary

Modifier and Type	Method and Description
int	getWebsocketAutomaticPingIntervalSeconds() When automatic pings are enabled for WebSocket connections, how many seconds should be waited between two pings? Defaults to 20 seconds.
int	getWebsocketDefaultClosingCode() The default code to send to the IWebsocketClientHandler when a WebSocket connection was found to be closed.
String	getWebsocketDefaultClosingReason() The default reason to send to the IWebsocketClientHandler when a WebSocket connection was found to be closed.
String	getWebsocketPingMessageString() The ping text to use.
ThreadFactory	getWebsocketThreadExecutorForClientEventsThreadFactory() The ThreadFactory to use to create threads to send WebSocket events to the IWebsocketClientHandler.
int	getWebsocketThreadExecutorForClientEventsThreadNumber() The maximum number of concurrent threads used when sending events to the IWebsocketClientHandler.
int	getWebsocketThreadExecutorForClientEventsTimeoutAmount() The timeout amount before cancelling a task when sending events to the IWebsocketClientHandler.
TimeUnit	getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit() The timeout TimeUnit before cancelling a task when sending events to the IWebsocketClientHandler.
boolean	isWebsocketAutomaticPingEnabled() Are automatic pings enabled when a WebSocket connection is established? Default to true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpincastHttpClientWithWebsocketConfigDefault

public SpincastHttpClientWithWebsocketConfigDefault()

Method Detail

isWebsocketAutomaticPingEnabled

public boolean isWebsocketAutomaticPingEnabled()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

Are automatic pings enabled when a WebSocket connection is established? Default to true.

Specified by:

isWebsocketAutomaticPingEnabled in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketAutomaticPingIntervalSeconds

public int getWebsocketAutomaticPingIntervalSeconds()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

When automatic pings are enabled for WebSocket connections, how many seconds should be waited between two pings? Defaults to 20 seconds.

Specified by:

getWebsocketAutomaticPingIntervalSeconds in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketPingMessageString

public String getWebsocketPingMessageString()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

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

Specified by:

getWebsocketPingMessageString in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketThreadExecutorForClientEventsThreadNumber

public int getWebsocketThreadExecutorForClientEventsThreadNumber()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

The maximum number of concurrent threads used when sending events to the IWebsocketClientHandler. Defaults to 10.

Specified by:

getWebsocketThreadExecutorForClientEventsThreadNumber in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketThreadExecutorForClientEventsTimeoutAmount

public int getWebsocketThreadExecutorForClientEventsTimeoutAmount()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

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

Specified by:

getWebsocketThreadExecutorForClientEventsTimeoutAmount in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit

public TimeUnit getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

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

Specified by:

getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketThreadExecutorForClientEventsThreadFactory

public ThreadFactory getWebsocketThreadExecutorForClientEventsThreadFactory()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

The ThreadFactory to use to create threads to send WebSocket events to the IWebsocketClientHandler. Defaults to null.

Specified by:

getWebsocketThreadExecutorForClientEventsThreadFactory in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketDefaultClosingCode

public int getWebsocketDefaultClosingCode()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

The default code to send to the IWebsocketClientHandler when a WebSocket connection was found to be closed. Valid codes can be found here Defaults to 1001: "1001 indicates that an endpoint is "going away", such as a server going down or a browser having navigated away from a page.."

Specified by:

getWebsocketDefaultClosingCode in interface ISpincastHttpClientWithWebsocketConfig

getWebsocketDefaultClosingReason

public String getWebsocketDefaultClosingReason()

Description copied from interface: ISpincastHttpClientWithWebsocketConfig

The default reason to send to the IWebsocketClientHandler when a WebSocket connection was found to be closed. Defaults to an empty message.

Specified by:

getWebsocketDefaultClosingReason in interface ISpincastHttpClientWithWebsocketConfig