Package org.spincast.plugins.httpclient.websocket

Interface SpincastHttpClientWithWebsocketConfig

All Superinterfaces:
SpincastHttpClientConfig
All Known Implementing Classes:
SpincastHttpClientWithWebsocketConfigDefault
public interface SpincastHttpClientWithWebsocketConfig extends SpincastHttpClientConfig
Configurations for the Spincast Http Client with WebSocket support plugin. We use "@ImplementedBy" to specify the default configurations to use if none is specified in a Guice module.

  • Method Details

    • isWebsocketAutomaticPingEnabled

      boolean isWebsocketAutomaticPingEnabled()
      Are automatic pings enabled when a WebSocket connection is established? Default to true.

    • getWebsocketAutomaticPingIntervalSeconds

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

    • getWebsocketPingMessageString

      String getWebsocketPingMessageString()
      The ping text to use. Must be < 125 characters. Defaults to "__ping"

    • getWebsocketThreadExecutorForClientEventsThreadNumber

      int getWebsocketThreadExecutorForClientEventsThreadNumber()
      The maximum number of concurrent threads used when sending events to the WebsocketClientHandler. Defaults to 10.

    • getWebsocketThreadExecutorForClientEventsTimeoutAmount

      int getWebsocketThreadExecutorForClientEventsTimeoutAmount()
      The timeout amount before cancelling a task when sending events to the WebsocketClientHandler. Defaults to 60.

    • getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit

      TimeUnit getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit()
      The timeout TimeUnit before cancelling a task when sending events to the WebsocketClientHandler. Defaults to SECONDS.

    • getWebsocketThreadExecutorForClientEventsThreadFactory

      ThreadFactory getWebsocketThreadExecutorForClientEventsThreadFactory()
      The ThreadFactory to use to create threads to send WebSocket events to the WebsocketClientHandler. Defaults to null.

    • getWebsocketDefaultClosingCode

      int getWebsocketDefaultClosingCode()
      The default code to send to the WebsocketClientHandler 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.."

    • getWebsocketDefaultClosingReason

      String getWebsocketDefaultClosingReason()
      The default reason to send to the WebsocketClientHandler when a WebSocket connection was found to be closed. Defaults to an empty message.