public.javadoc.org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastHttpClientWithWebsocketConfig (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 Summary

All Methods Instance Methods Abstract Methods 

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 WebsocketClientHandler when a WebSocket connection
 was found to be closed.



String
getWebsocketDefaultClosingReason()
The default reason to send to the WebsocketClientHandler 
 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 WebsocketClientHandler.



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



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



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



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
















Method Detail





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.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

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 `WebsocketClientHandler` when a WebSocket connection was found to be closed.
`String`	`getWebsocketDefaultClosingReason()` The default reason to send to the `WebsocketClientHandler` 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 `WebsocketClientHandler`.
`int`	`getWebsocketThreadExecutorForClientEventsThreadNumber()` The maximum number of concurrent threads used when sending events to the `WebsocketClientHandler`.
`int`	`getWebsocketThreadExecutorForClientEventsTimeoutAmount()` The timeout `amount` before cancelling a task when sending events to the `WebsocketClientHandler`.
`TimeUnit`	`getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit()` The timeout `TimeUnit` before cancelling a task when sending events to the `WebsocketClientHandler`.
`boolean`	`isWebsocketAutomaticPingEnabled()` Are automatic pings enabled when a WebSocket connection is established? Default to `true`.