Index
All Classes and Interfaces|All Packages
B
- backoffStrategy() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Helper class to compute delays between connection retries
- backoffStrategy(IBackoffStrategy) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Helper class to compute delays between connection retries
- baseUrl() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
The websocket url for the chat client to connect to.
- baseUrl(String) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
The websocket url for the chat client to connect to.
C
- close() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
- closed - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
-
Whether
WebsocketConnection.close()has been called - closeDelay() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
The maximum number of milliseconds to wait after sending a close frame to receive confirmation from the server, before fully closing the socket.
- closeDelay(int) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
The maximum number of milliseconds to wait after sending a close frame to receive confirmation from the server, before fully closing the socket.
- closeLatch - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
-
Latch used to indicate that the underlying socket has fully disconnected following
WebsocketConnection.close(). - com.github.twitch4j.client.websocket - package com.github.twitch4j.client.websocket
- com.github.twitch4j.client.websocket.domain - package com.github.twitch4j.client.websocket.domain
- config - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
-
connection configuration
- connect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
-
Connect to the WebSocket
- CONNECTED - Enum constant in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
The websocket has established a connection after completing the connection handshake procedure.
- CONNECTING - Enum constant in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
The websocket has started its connection procedure after a call to
WebsocketConnection.connect(). - connectionTimeout() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Websocket timeout milliseconds for establishing a connection (0 = disabled).
- connectionTimeout(int) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Websocket timeout milliseconds for establishing a connection (0 = disabled).
- createWebsocket() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
D
- disconnect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
-
Disconnect from the WebSocket
- DISCONNECTED - Enum constant in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
The websocket is (deliberately) fully disconnected.
- DISCONNECTING - Enum constant in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
The websocket is in the process of disconnecting after a call to
WebsocketConnection.disconnect().
G
- getConfig() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
-
connection configuration
- getConnectionState() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
- getLatency() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
H
- headers() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
WebSocket Headers
- headers(Map<String, String>) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
WebSocket Headers
L
- lastPing - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
-
Tracks the timestamp of the last outbound ping
- latency - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
- LOST - Enum constant in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
The websocket inadvertently lost connection.
O
- onCloseFrame() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after receiving a close frame from the server
- onCloseFrame(BiConsumer<Integer, String>) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after receiving a close frame from the server
- onConnected() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after the connection to the websocket server has been established successfully
- onConnected(Runnable) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after the connection to the websocket server has been established successfully
- onDisconnecting() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called when connection state is changing from CONNECTED to DISCONNECTING
- onDisconnecting(Runnable) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called when connection state is changing from CONNECTED to DISCONNECTING
- onPostConnect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after connecting
- onPostConnect(Runnable) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after connecting
- onPostDisconnect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after the disconnect
- onPostDisconnect(Runnable) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called after the disconnect
- onPreConnect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called before connecting
- onPreConnect(Runnable) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called before connecting
- onPreDisconnect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called before the disconnect
- onPreDisconnect(Runnable) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called before the disconnect
- onStateChanged() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called when the websocket's state changes
- onStateChanged(BiConsumer<WebsocketConnectionState, WebsocketConnectionState>) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called when the websocket's state changes
- onTextMessage() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called when receiving a text message on from the websocket server
- onTextMessage(Consumer<String>) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
called when receiving a text message on from the websocket server
P
- process(Consumer<WebsocketConnectionConfig>) - Static method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
- proxyConfig() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
proxy config
- proxyConfig(ProxyConfig) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
proxy config
R
- reconnect() - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
-
Reconnecting to the WebSocket
- RECONNECTING - Enum constant in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
The websocket has started its reconnection procedure after a call to
WebsocketConnection.reconnect().
S
- sendText(String) - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
-
sends a message to the websocket server
- setState(WebsocketConnectionState) - Method in class com.github.twitch4j.client.websocket.WebsocketConnection
- socketTimeout() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Websocket timeout milliseconds for read and write operations (0 = disabled).
- socketTimeout(int) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Websocket timeout milliseconds for read and write operations (0 = disabled).
T
- taskExecutor() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Task Executor
- taskExecutor(ScheduledExecutorService) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
Task Executor
V
- validate() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
validate the config
- valueOf(String) - Static method in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.twitch4j.client.websocket.domain.WebsocketConnectionState
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- webSocketAdapter - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
-
WebSocket Adapter
- WebsocketConnection - Class in com.github.twitch4j.client.websocket
- WebsocketConnection(Consumer<WebsocketConnectionConfig>) - Constructor for class com.github.twitch4j.client.websocket.WebsocketConnection
-
TwitchWebsocketConnection
- WebsocketConnectionConfig - Class in com.github.twitch4j.client.websocket
- WebsocketConnectionConfig() - Constructor for class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
- WebsocketConnectionState - Enum Class in com.github.twitch4j.client.websocket.domain
-
The state of a
WebsocketConnection. - webSocketFactory - Variable in class com.github.twitch4j.client.websocket.WebsocketConnection
-
WebSocket Factory
- wsPingPeriod() - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
WebSocket RFC Ping Period in ms (0 = disabled)
- wsPingPeriod(int) - Method in class com.github.twitch4j.client.websocket.WebsocketConnectionConfig
-
WebSocket RFC Ping Period in ms (0 = disabled)
All Classes and Interfaces|All Packages