Index
All Classes and Interfaces|All Packages
A
- addCustomCookies(Map<String, List<String>>) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- addCustomHeaders(Map<String, List<String>>) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- addHttpAuthHeaders(Map<String, List<String>>) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- addSslContext(WebSocketClient.ConnectionBuilder) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- addWebsocketRequestHeaders() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
B
- bindHttpClientFactory() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
-
Override to bind WebsocketRequestBuilder too.
- bindSpincastHttpClientWithWebsocketUtils() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
C
- closeConnection() - Method in interface org.spincast.plugins.httpclient.websocket.WebsocketClientWriter
-
Closes the WebSocket connection.
- configure() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
- connect(WebsocketClientHandler) - Method in interface org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilder
-
Sends the request and establish the WebSocket connection.
- connect(WebsocketClientHandler) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createByteBufferPool() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createConnectionBuilder(XnioWorker, DefaultByteBufferPool, String) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createMethodSpecificHttpRequest(String) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createSupportedExtensions() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createSupportedSubProtocols() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createWebSocketChannel() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createWebSocketChannel(XnioWorker, DefaultByteBufferPool, String, int) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createWebsocketUri(String) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- createXnioWorker() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
G
- getId() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPlugin
- getPingsIntervalSeconds() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getPluginModule() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPlugin
- getSpincastHttpClientUtilsClass() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
- getSpincastHttpClientUtilsWithWebsocketClass() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
- getSpincastHttpClientWithWebsocketConfig() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getSpincastHttpClientWithWebsocketUtils() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getSslContext() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getThreadExecutorForClientEvents() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
The ExecutorService to use to send events to the client.
- getThreadExecutorForClientEventsThreadNumber() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
The maximum number of concurrent threads used when sending events to the application.
- getThreadExecutorForClientEventsThreadThreadFactory() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
The ThreadFactory to use for the Executor that sends events to the client.
- getThreadExecutorForClientEventsTimeoutAmount() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
The timeout amount before cancelling a task when sending events to the application.
- getThreadExecutorForClientEventsTimeoutTimeUnit() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
The timeout asdasd before cancelling a task when sending events to the application.
- getWebsocketAutomaticPingIntervalSeconds() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
When automatic pings are enabled for WebSocket connections, how many seconds should be waited between two pings? Defaults to
20seconds. - getWebsocketAutomaticPingIntervalSeconds() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketClientReader() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getWebsocketDefaultClosingCode() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The default code to send to the
WebsocketClientHandlerwhen a WebSocket connection was found to be closed. - getWebsocketDefaultClosingCode() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketDefaultClosingReason() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The default reason to send to the
WebsocketClientHandlerwhen a WebSocket connection was found to be closed. - getWebsocketDefaultClosingReason() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketPingMessageString() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The ping text to use.
- getWebsocketPingMessageString() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketThreadExecutorForClientEventsThreadFactory() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The
ThreadFactoryto use to create threads to send WebSocket events to theWebsocketClientHandler. - getWebsocketThreadExecutorForClientEventsThreadFactory() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketThreadExecutorForClientEventsThreadNumber() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The maximum number of concurrent threads used when sending events to the
WebsocketClientHandler. - getWebsocketThreadExecutorForClientEventsThreadNumber() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketThreadExecutorForClientEventsTimeoutAmount() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The timeout
amountbefore cancelling a task when sending events to theWebsocketClientHandler. - getWebsocketThreadExecutorForClientEventsTimeoutAmount() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
The timeout
TimeUnitbefore cancelling a task when sending events to theWebsocketClientHandler. - getWebsocketThreadExecutorForClientEventsTimeoutTimeUnit() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- getWebsocketWriteCallback(WebsocketClientHandler) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getXnio() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- getXnioInstance() - Method in interface org.spincast.plugins.httpclient.websocket.utils.SpincastHttpClientWithWebsocketUtils
- getXnioInstance() - Method in class org.spincast.plugins.httpclient.websocket.utils.SpincastHttpClientWithWebsocketUtilsDefault
H
- HttpClient - Interface in org.spincast.plugins.httpclient.websocket
I
- isWebsocketAutomaticPingEnabled() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfig
-
Are automatic pings enabled when a WebSocket connection is established? Default to
true. - isWebsocketAutomaticPingEnabled() - Method in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
L
- logger - Static variable in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
O
- onConnectionClosed(int, String) - Method in interface org.spincast.plugins.httpclient.websocket.WebsocketClientHandler
-
Called when if the endpoint closes the connection.
- onEndpointMessage(byte[]) - Method in interface org.spincast.plugins.httpclient.websocket.WebsocketClientHandler
-
The endpoint sent a bytes[] message.
- onEndpointMessage(String) - Method in interface org.spincast.plugins.httpclient.websocket.WebsocketClientHandler
-
The endpoint sent a String message.
- org.spincast.plugins.httpclient.websocket - package org.spincast.plugins.httpclient.websocket
- org.spincast.plugins.httpclient.websocket.builders - package org.spincast.plugins.httpclient.websocket.builders
- org.spincast.plugins.httpclient.websocket.utils - package org.spincast.plugins.httpclient.websocket.utils
P
- ping(int) - Method in interface org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilder
-
You can use this to configure the pings that are automatically sent to the Websocket endpoint every X seconds.
- ping(int) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- PLUGIN_ID - Static variable in class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPlugin
S
- send() - Method in interface org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilder
-
Sends the request and gets the
HTTPresponse. - send() - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- sendClientEventInNewThread(Runnable) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
Sends an event to the client in a separated thread.
- sendConnectionClosedAppEvent(WebsocketClientHandler) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
- sendMessage(byte[]) - Method in interface org.spincast.plugins.httpclient.websocket.WebsocketClientWriter
-
Sends a binary message to the endpoint
- sendMessage(String) - Method in interface org.spincast.plugins.httpclient.websocket.WebsocketClientWriter
-
Sends a text message to the endpoint.
- sendOnBytesMessageClientEvent(byte[]) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
Sends a "Bytes message" event to the app.
- sendOnConnectionClosedMessageClientEvent(int, String) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
Sends a "Connection closed message" event to the app.
- sendOnStringMessageClientEvent(String) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
Sends a "String message" event to the app.
- sendPing() - Method in interface org.spincast.plugins.httpclient.websocket.SpincastWebsocketClientWriter
-
Sends a ping
- SpincastHttpClientWithWebsocketConfig - Interface in org.spincast.plugins.httpclient.websocket
-
Configurations for the Spincast Http Client with WebSocket support plugin.
- SpincastHttpClientWithWebsocketConfigDefault - Class in org.spincast.plugins.httpclient.websocket
-
Default configurations for the Spincast Http Client with Websocket support plugin.
- SpincastHttpClientWithWebsocketConfigDefault() - Constructor for class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketConfigDefault
- SpincastHttpClientWithWebsocketPlugin - Class in org.spincast.plugins.httpclient.websocket
- SpincastHttpClientWithWebsocketPlugin() - Constructor for class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPlugin
- SpincastHttpClientWithWebsocketPluginModule - Class in org.spincast.plugins.httpclient.websocket
-
Guice module for the Spincast Http Client with Websocket support plugin.
- SpincastHttpClientWithWebsocketPluginModule() - Constructor for class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
- SpincastHttpClientWithWebsocketPluginModule(Class<? extends RequestContext<?>>, Class<? extends WebsocketContext<?>>) - Constructor for class org.spincast.plugins.httpclient.websocket.SpincastHttpClientWithWebsocketPluginModule
- SpincastHttpClientWithWebsocketUtils - Interface in org.spincast.plugins.httpclient.websocket.utils
- SpincastHttpClientWithWebsocketUtilsDefault - Class in org.spincast.plugins.httpclient.websocket.utils
- SpincastHttpClientWithWebsocketUtilsDefault() - Constructor for class org.spincast.plugins.httpclient.websocket.utils.SpincastHttpClientWithWebsocketUtilsDefault
- SpincastWebsocketClientWriter - Interface in org.spincast.plugins.httpclient.websocket
-
Spincast Websocket client writer
- startSendingPings(SpincastWebsocketClientWriter) - Method in class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
W
- websocket(String) - Method in interface org.spincast.plugins.httpclient.websocket.HttpClient
-
Starts a builder for a websocket request.
- WebsocketClientHandler - Interface in org.spincast.plugins.httpclient.websocket
-
A Websocket client reader
- WebsocketClientWriter - Interface in org.spincast.plugins.httpclient.websocket
-
A Websocket client writer
- WebsocketRequestBuilder - Interface in org.spincast.plugins.httpclient.websocket.builders
-
Builder to create a WebSocket requesté
- WebsocketRequestBuilderDefault - Class in org.spincast.plugins.httpclient.websocket.builders
- WebsocketRequestBuilderDefault(String, CookieFactory, HttpResponseFactory, SpincastHttpClientWithWebsocketUtils, SpincastHttpClientWithWebsocketConfig) - Constructor for class org.spincast.plugins.httpclient.websocket.builders.WebsocketRequestBuilderDefault
-
Constructor
All Classes and Interfaces|All Packages