-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
AbstractWebSocket.java
367 lines (333 loc) · 10.3 KB
/
AbstractWebSocket.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
/*
* Copyright (c) 2010-2020 Nathan Rajlich
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
package org.java_websocket;
import java.util.ArrayList;
import java.util.Collection;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.java_websocket.framing.CloseFrame;
import org.java_websocket.util.NamedThreadFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Base class for additional implementations for the server as well as the client
*/
public abstract class AbstractWebSocket extends WebSocketAdapter {
/**
* Logger instance
*
* @since 1.4.0
*/
private final Logger log = LoggerFactory.getLogger(AbstractWebSocket.class);
/**
* Attribute which allows you to deactivate the Nagle's algorithm
*
* @since 1.3.3
*/
private boolean tcpNoDelay;
/**
* Attribute which allows you to enable/disable the SO_REUSEADDR socket option.
*
* @since 1.3.5
*/
private boolean reuseAddr;
/**
* Attribute for a service that triggers lost connection checking
*
* @since 1.4.1
*/
private ScheduledExecutorService connectionLostCheckerService;
/**
* Attribute for a task that checks for lost connections
*
* @since 1.4.1
*/
private ScheduledFuture<?> connectionLostCheckerFuture;
/**
* Attribute for the lost connection check interval in nanoseconds
*
* @since 1.3.4
*/
private long connectionLostTimeout = TimeUnit.SECONDS.toNanos(60);
/**
* Attribute to keep track if the WebSocket Server/Client is running/connected
*
* @since 1.3.9
*/
private boolean websocketRunning = false;
/**
* Attribute to start internal threads as daemon
*
* @since 1.5.6
*/
private boolean daemon = false;
/**
* Attribute to sync on
*/
private final Object syncConnectionLost = new Object();
/**
* TCP receive buffer size that will be used for sockets
*
* @since 1.5.7
*/
private int receiveBufferSize = 16384;
/**
* Get the interval checking for lost connections Default is 60 seconds
*
* @return the interval in seconds
* @since 1.3.4
*/
public int getConnectionLostTimeout() {
synchronized (syncConnectionLost) {
return (int) TimeUnit.NANOSECONDS.toSeconds(connectionLostTimeout);
}
}
/**
* Setter for the interval checking for lost connections A value lower or equal 0 results in the
* check to be deactivated
*
* @param connectionLostTimeout the interval in seconds
* @since 1.3.4
*/
public void setConnectionLostTimeout(int connectionLostTimeout) {
synchronized (syncConnectionLost) {
this.connectionLostTimeout = TimeUnit.SECONDS.toNanos(connectionLostTimeout);
if (this.connectionLostTimeout <= 0) {
log.trace("Connection lost timer stopped");
cancelConnectionLostTimer();
return;
}
if (this.websocketRunning) {
log.trace("Connection lost timer restarted");
//Reset all the pings
try {
ArrayList<WebSocket> connections = new ArrayList<>(getConnections());
WebSocketImpl webSocketImpl;
for (WebSocket conn : connections) {
if (conn instanceof WebSocketImpl) {
webSocketImpl = (WebSocketImpl) conn;
webSocketImpl.updateLastPong();
}
}
} catch (Exception e) {
log.error("Exception during connection lost restart", e);
}
restartConnectionLostTimer();
}
}
}
/**
* Stop the connection lost timer
*
* @since 1.3.4
*/
protected void stopConnectionLostTimer() {
synchronized (syncConnectionLost) {
if (connectionLostCheckerService != null || connectionLostCheckerFuture != null) {
this.websocketRunning = false;
log.trace("Connection lost timer stopped");
cancelConnectionLostTimer();
}
}
}
/**
* Start the connection lost timer
*
* @since 1.3.4
*/
protected void startConnectionLostTimer() {
synchronized (syncConnectionLost) {
if (this.connectionLostTimeout <= 0) {
log.trace("Connection lost timer deactivated");
return;
}
log.trace("Connection lost timer started");
this.websocketRunning = true;
restartConnectionLostTimer();
}
}
/**
* This methods allows the reset of the connection lost timer in case of a changed parameter
*
* @since 1.3.4
*/
private void restartConnectionLostTimer() {
cancelConnectionLostTimer();
connectionLostCheckerService = Executors
.newSingleThreadScheduledExecutor(new NamedThreadFactory("connectionLostChecker", daemon));
Runnable connectionLostChecker = new Runnable() {
/**
* Keep the connections in a separate list to not cause deadlocks
*/
private ArrayList<WebSocket> connections = new ArrayList<>();
@Override
public void run() {
connections.clear();
try {
connections.addAll(getConnections());
long minimumPongTime;
synchronized (syncConnectionLost) {
minimumPongTime = (long) (System.nanoTime() - (connectionLostTimeout * 1.5));
}
for (WebSocket conn : connections) {
executeConnectionLostDetection(conn, minimumPongTime);
}
} catch (Exception e) {
//Ignore this exception
}
connections.clear();
}
};
connectionLostCheckerFuture = connectionLostCheckerService
.scheduleAtFixedRate(connectionLostChecker, connectionLostTimeout, connectionLostTimeout,
TimeUnit.NANOSECONDS);
}
/**
* Send a ping to the endpoint or close the connection since the other endpoint did not respond
* with a ping
*
* @param webSocket the websocket instance
* @param minimumPongTime the lowest/oldest allowable last pong time (in nanoTime) before we
* consider the connection to be lost
*/
private void executeConnectionLostDetection(WebSocket webSocket, long minimumPongTime) {
if (!(webSocket instanceof WebSocketImpl)) {
return;
}
WebSocketImpl webSocketImpl = (WebSocketImpl) webSocket;
if (webSocketImpl.getLastPong() < minimumPongTime) {
log.trace("Closing connection due to no pong received: {}", webSocketImpl);
webSocketImpl.closeConnection(CloseFrame.ABNORMAL_CLOSE,
"The connection was closed because the other endpoint did not respond with a pong in time. For more information check: https://github.com/TooTallNate/Java-WebSocket/wiki/Lost-connection-detection");
} else {
if (webSocketImpl.isOpen()) {
webSocketImpl.sendPing();
} else {
log.trace("Trying to ping a non open connection: {}", webSocketImpl);
}
}
}
/**
* Getter to get all the currently available connections
*
* @return the currently available connections
* @since 1.3.4
*/
protected abstract Collection<WebSocket> getConnections();
/**
* Cancel any running timer for the connection lost detection
*
* @since 1.3.4
*/
private void cancelConnectionLostTimer() {
if (connectionLostCheckerService != null) {
connectionLostCheckerService.shutdownNow();
connectionLostCheckerService = null;
}
if (connectionLostCheckerFuture != null) {
connectionLostCheckerFuture.cancel(false);
connectionLostCheckerFuture = null;
}
}
/**
* Tests if TCP_NODELAY is enabled.
*
* @return a boolean indicating whether or not TCP_NODELAY is enabled for new connections.
* @since 1.3.3
*/
public boolean isTcpNoDelay() {
return tcpNoDelay;
}
/**
* Setter for tcpNoDelay
* <p>
* Enable/disable TCP_NODELAY (disable/enable Nagle's algorithm) for new connections
*
* @param tcpNoDelay true to enable TCP_NODELAY, false to disable.
* @since 1.3.3
*/
public void setTcpNoDelay(boolean tcpNoDelay) {
this.tcpNoDelay = tcpNoDelay;
}
/**
* Tests Tests if SO_REUSEADDR is enabled.
*
* @return a boolean indicating whether or not SO_REUSEADDR is enabled.
* @since 1.3.5
*/
public boolean isReuseAddr() {
return reuseAddr;
}
/**
* Setter for soReuseAddr
* <p>
* Enable/disable SO_REUSEADDR for the socket
*
* @param reuseAddr whether to enable or disable SO_REUSEADDR
* @since 1.3.5
*/
public void setReuseAddr(boolean reuseAddr) {
this.reuseAddr = reuseAddr;
}
/**
* Getter for daemon
*
* @return whether internal threads are spawned in daemon mode
* @since 1.5.6
*/
public boolean isDaemon() {
return daemon;
}
/**
* Setter for daemon
* <p>
* Controls whether or not internal threads are spawned in daemon mode
*
* @since 1.5.6
*/
public void setDaemon(boolean daemon) {
this.daemon = daemon;
}
/**
* Returns the TCP receive buffer size that will be used for sockets.
* @see java.net.Socket#setReceiveBufferSize(int)
*
* @since 1.5.7
*/
public int getReceiveBufferSize() {
return receiveBufferSize;
}
/**
* Sets the TCP receive buffer size that will be used for sockets.
* @see java.net.Socket#setReceiveBufferSize(int)
*
* @since 1.5.7
*/
public void setReceiveBufferSize(int receiveBufferSize) {
this.receiveBufferSize = receiveBufferSize;
}
}