public class SpincastHttpClientWithWebsocketConfigDefault extends SpincastHttpClientConfigDefault implements SpincastHttpClientWithWebsocketConfig
Constructor and Description |
---|
SpincastHttpClientWithWebsocketConfigDefault() |
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 . |
public SpincastHttpClientWithWebsocketConfigDefault()
public boolean isWebsocketAutomaticPingEnabled()
SpincastHttpClientWithWebsocketConfig
true
.isWebsocketAutomaticPingEnabled
in interface SpincastHttpClientWithWebsocketConfig
public int getWebsocketAutomaticPingIntervalSeconds()
SpincastHttpClientWithWebsocketConfig
20
seconds.getWebsocketAutomaticPingIntervalSeconds
in interface SpincastHttpClientWithWebsocketConfig
public String getWebsocketPingMessageString()
SpincastHttpClientWithWebsocketConfig
< 125
characters.
Defaults to "__ping"
getWebsocketPingMessageString
in interface SpincastHttpClientWithWebsocketConfig
public int getWebsocketThreadExecutorForClientEventsThreadNumber()
SpincastHttpClientWithWebsocketConfig
WebsocketClientHandler
.
Defaults to 10
.getWebsocketThreadExecutorForClientEventsThreadNumber
in interface SpincastHttpClientWithWebsocketConfig
public int getWebsocketThreadExecutorForClientEventsTimeoutAmount()
SpincastHttpClientWithWebsocketConfig
amount
before cancelling a task when
sending events to the WebsocketClientHandler
.
Defaults to 60
.getWebsocketThreadExecutorForClientEventsTimeoutAmount
in interface SpincastHttpClientWithWebsocketConfig
public TimeUnit getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit()
SpincastHttpClientWithWebsocketConfig
TimeUnit
before cancelling a task when
sending events to the WebsocketClientHandler
.
Defaults to SECONDS
.getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit
in interface SpincastHttpClientWithWebsocketConfig
public ThreadFactory getWebsocketThreadExecutorForClientEventsThreadFactory()
SpincastHttpClientWithWebsocketConfig
ThreadFactory
to use to create threads to send WebSocket events
to the WebsocketClientHandler
.
Defaults to null
.getWebsocketThreadExecutorForClientEventsThreadFactory
in interface SpincastHttpClientWithWebsocketConfig
public int getWebsocketDefaultClosingCode()
SpincastHttpClientWithWebsocketConfig
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.."getWebsocketDefaultClosingCode
in interface SpincastHttpClientWithWebsocketConfig
public String getWebsocketDefaultClosingReason()
SpincastHttpClientWithWebsocketConfig
WebsocketClientHandler
when a WebSocket connection was found to be closed.
Defaults to an empty message.getWebsocketDefaultClosingReason
in interface SpincastHttpClientWithWebsocketConfig
Copyright © 2019. All rights reserved.