Repository navigation
Expand file tree
/
Copy pathWebSocket.java
More file actions
679 lines (615 loc) · 22.4 KB
/
Copy pathWebSocket.java
File metadata and controls
679 lines (615 loc) · 22.4 KB
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
package org.java_websocket;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.NotYetConnectedException;
import java.nio.channels.SocketChannel;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.atomic.AtomicLong;
import org.java_websocket.drafts.Draft;
import org.java_websocket.drafts.Draft.CloseHandshakeType;
import org.java_websocket.drafts.Draft.HandshakeState;
import org.java_websocket.drafts.Draft_10;
import org.java_websocket.drafts.Draft_17;
import org.java_websocket.drafts.Draft_75;
import org.java_websocket.drafts.Draft_76;
import org.java_websocket.exeptions.IncompleteHandshakeException;
import org.java_websocket.exeptions.InvalidDataException;
import org.java_websocket.exeptions.InvalidFrameException;
import org.java_websocket.exeptions.InvalidHandshakeException;
import org.java_websocket.framing.CloseFrame;
import org.java_websocket.framing.CloseFrameBuilder;
import org.java_websocket.framing.Framedata;
import org.java_websocket.framing.Framedata.Opcode;
import org.java_websocket.handshake.ClientHandshake;
import org.java_websocket.handshake.ClientHandshakeBuilder;
import org.java_websocket.handshake.Handshakedata;
import org.java_websocket.handshake.ServerHandshake;
import org.java_websocket.handshake.ServerHandshakeBuilder;
import org.java_websocket.util.Charsetfunctions;
/**
* Represents one end (client or server) of a single WebSocket connection.
* Takes care of the "handshake" phase, then allows for easy sending of
* text frames, and receiving frames through an event-based model.
*
* This is an inner class, used by <tt>WebSocketClient</tt> and <tt>WebSocketServer</tt>, and should never need to be instantiated directly
* by your code. However, instances are exposed in <tt>WebSocketServer</tt> through the <i>onClientOpen</i>, <i>onClientClose</i>,
* <i>onClientMessage</i> callbacks.
*
* @author Nathan Rajlich
*/
public final class WebSocket {
public enum Role {
CLIENT, SERVER
}
public static final int READY_STATE_CONNECTING = 0;
public static final int READY_STATE_OPEN = 1;
public static final int READY_STATE_CLOSING = 2;
public static final int READY_STATE_CLOSED = 3;
public static int BUFFERSIZE = 4096;
/**
* The default port of WebSockets, as defined in the spec. If the nullary
* constructor is used, DEFAULT_PORT will be the port the WebSocketServer
* is binded to. Note that ports under 1024 usually require root permissions.
*/
public static final int DEFAULT_PORT = 80;
public static/*final*/boolean DEBUG = false; // must be final in the future in order to take advantage of VM optimization
/**
* Determines whether to receive data as part of the
* handshake, or as part of text/data frame transmitted over the websocket.
*/
private boolean handshakeComplete = false;
/**
* Determines whether we sent already a request to Close the connection or not.
*/
private boolean closeHandshakeSent = false;
/**
* Determines wheter the connection is open or not
*/
private boolean connectionClosed = false;
/**
* The listener to notify of WebSocket events.
*/
private WebSocketListener wsl;
/**
* Buffer where data is read to from the socket
*/
private ByteBuffer socketBuffer;
/**
* Queue of buffers that need to be sent to the client.
*/
private BlockingQueue<ByteBuffer> bufferQueue;
/**
* The amount of bytes still in queue to be sent, at every given time.
* It's updated at every send/sent operation.
*/
private AtomicLong bufferQueueTotalAmount = new AtomicLong( 0l );
private Draft draft = null;
private Role role;
private Framedata currentframe;
private ClientHandshake handshakerequest = null;
public List<Draft> known_drafts;
private SocketChannel sockchannel;
// CONSTRUCTOR /////////////////////////////////////////////////////////////
/**
* Used in {@link WebSocketServer} and {@link WebSocketClient}.
*
* @param socketchannel
* The <tt>SocketChannel</tt> instance to read and
* write to. The channel should already be registered
* with a Selector before construction of this object.
* @param listener
* The {@link WebSocketListener} to notify of events when
* they occur.
*/
public WebSocket( WebSocketListener listener , Draft draft , SocketChannel socketchannel ) {
init( listener, draft, socketchannel );
}
public WebSocket( WebSocketListener listener , List<Draft> drafts , SocketChannel socketchannel ) {
init( listener, null, socketchannel );
this.role = Role.SERVER;
if( known_drafts == null || known_drafts.isEmpty() ) {
known_drafts = new ArrayList<Draft>( 1 );
known_drafts.add( new Draft_17() );
known_drafts.add( new Draft_10() );
known_drafts.add( new Draft_76() );
known_drafts.add( new Draft_75() );
} else {
known_drafts = drafts;
}
}
private void init( WebSocketListener listener, Draft draft, SocketChannel socketchannel ) {
this.sockchannel = socketchannel;
this.bufferQueue = new LinkedBlockingQueue<ByteBuffer>( 3 );
this.socketBuffer = ByteBuffer.allocate( BUFFERSIZE );
socketBuffer.flip();
this.wsl = listener;
this.role = Role.CLIENT;
this.draft = draft;
}
/**
* Should be called when a Selector has a key that is writable for this
* WebSocket's SocketChannel connection.
*
* @throws IOException
* When socket related I/O errors occur.
* @throws InterruptedException
*/
/*package public*/void handleRead() throws IOException {
if( !socketBuffer.hasRemaining() ) {
socketBuffer.rewind();
socketBuffer.limit( socketBuffer.capacity() );
if( sockchannel.read( socketBuffer ) == -1 ) {
if( draft == null ) {
closeConnection( CloseFrame.ABNROMAL_CLOSE, true );
} else if( draft.getCloseHandshakeType() == CloseHandshakeType.NONE ) {
closeConnection( CloseFrame.NORMAL, true );
} else if( draft.getCloseHandshakeType() == CloseHandshakeType.ONEWAY ) {
if( role == Role.SERVER )
closeConnection( CloseFrame.ABNROMAL_CLOSE, true );
else
closeConnection( CloseFrame.NORMAL, true );
} else {
closeConnection( CloseFrame.ABNROMAL_CLOSE, true );
}
}
socketBuffer.flip();
}
if( socketBuffer.hasRemaining() ) {
if( DEBUG )
System.out.println( "process(" + socketBuffer.remaining() + "): {" + ( socketBuffer.remaining() > 1000 ? "too big to display" : new String( socketBuffer.array(), socketBuffer.position(), socketBuffer.remaining() ) ) + "}" );
if( !handshakeComplete ) {
if( draft == null ) {
HandshakeState isflashedgecase = isFlashEdgeCase( socketBuffer );
if( isflashedgecase == HandshakeState.MATCHED ) {
channelWriteDirect( ByteBuffer.wrap( Charsetfunctions.utf8Bytes( wsl.getFlashPolicy( this ) ) ) );
closeDirect( CloseFrame.FLASHPOLICY, "" );
return;
} else if( isflashedgecase == HandshakeState.MATCHING ) {
return;
}
}
HandshakeState handshakestate = null;
socketBuffer.mark();
try {
if( role == Role.SERVER ) {
if( draft == null ) {
for( Draft d : known_drafts ) {
try {
d.setParseMode( role );
socketBuffer.reset();
Handshakedata tmphandshake = d.translateHandshake( socketBuffer );
if( tmphandshake instanceof ClientHandshake == false ) {
closeConnection( CloseFrame.PROTOCOL_ERROR, "wrong http function", false );
return;
}
ClientHandshake handshake = (ClientHandshake) tmphandshake;
handshakestate = d.acceptHandshakeAsServer( handshake );
if( handshakestate == HandshakeState.MATCHED ) {
ServerHandshakeBuilder response;
try {
response = wsl.onWebsocketHandshakeReceivedAsServer( this, d, handshake );
} catch ( InvalidDataException e ) {
closeConnection( e.getCloseCode(), e.getMessage(), false );
return;
}
writeDirect( d.createHandshake( d.postProcessHandshakeResponseAsServer( handshake, response ), role ) );
draft = d;
open( handshake );
handleRead();
return;
} else if( handshakestate == HandshakeState.MATCHING ) {
if( draft != null ) {
throw new InvalidHandshakeException( "multible drafts matching" );
}
draft = d;
}
} catch ( InvalidHandshakeException e ) {
// go on with an other draft
} catch ( IncompleteHandshakeException e ) {
if( socketBuffer.limit() == socketBuffer.capacity() ) {
close( CloseFrame.TOOBIG, "handshake is to big" );
}
// read more bytes for the handshake
socketBuffer.position( socketBuffer.limit() );
socketBuffer.limit( socketBuffer.capacity() );
return;
}
}
if( draft == null ) {
close( CloseFrame.PROTOCOL_ERROR, "no draft matches" );
}
return;
} else {
// special case for multiple step handshakes
Handshakedata tmphandshake = draft.translateHandshake( socketBuffer );
if( tmphandshake instanceof ClientHandshake == false ) {
closeConnection( CloseFrame.PROTOCOL_ERROR, "wrong http function", false );
return;
}
ClientHandshake handshake = (ClientHandshake) tmphandshake;
handshakestate = draft.acceptHandshakeAsServer( handshake );
if( handshakestate == HandshakeState.MATCHED ) {
open( handshake );
handleRead();
} else if( handshakestate != HandshakeState.MATCHING ) {
close( CloseFrame.PROTOCOL_ERROR, "the handshake did finaly not match" );
}
return;
}
} else if( role == Role.CLIENT ) {
draft.setParseMode( role );
Handshakedata tmphandshake = draft.translateHandshake( socketBuffer );
if( tmphandshake instanceof ServerHandshake == false ) {
closeConnection( CloseFrame.PROTOCOL_ERROR, "Wwrong http function", false );
return;
}
ServerHandshake handshake = (ServerHandshake) tmphandshake;
handshakestate = draft.acceptHandshakeAsClient( handshakerequest, handshake );
if( handshakestate == HandshakeState.MATCHED ) {
try {
wsl.onWebsocketHandshakeReceivedAsClient( this, handshakerequest, handshake );
} catch ( InvalidDataException e ) {
closeConnection( e.getCloseCode(), e.getMessage(), false );
return;
}
open( handshake );
handleRead();
} else if( handshakestate == HandshakeState.MATCHING ) {
return;
} else {
close( CloseFrame.PROTOCOL_ERROR, "draft " + draft + " refuses handshake" );
}
}
} catch ( InvalidHandshakeException e ) {
close( e );
}
} else {
// Receiving frames
List<Framedata> frames;
try {
frames = draft.translateFrame( socketBuffer );
for( Framedata f : frames ) {
if( DEBUG )
System.out.println( "matched frame: " + f );
Opcode curop = f.getOpcode();
if( curop == Opcode.CLOSING ) {
int code = CloseFrame.NOCODE;
String reason = "";
if( f instanceof CloseFrame ) {
CloseFrame cf = (CloseFrame) f;
code = cf.getCloseCode();
reason = cf.getMessage();
}
if( closeHandshakeSent ) {
// complete the close handshake by disconnecting
closeConnection( code, reason, true );
} else {
// echo close handshake
if( draft.getCloseHandshakeType() == CloseHandshakeType.TWOWAY )
close( code, reason );
closeConnection( code, reason, false );
}
continue;
} else if( curop == Opcode.PING ) {
wsl.onWebsocketPing( this, f );
continue;
} else if( curop == Opcode.PONG ) {
wsl.onWebsocketPong( this, f );
continue;
} else {
// process non control frames
if( currentframe == null ) {
if( f.getOpcode() == Opcode.CONTINIOUS ) {
throw new InvalidFrameException( "unexpected continious frame" );
} else if( f.isFin() ) {
// receive normal onframe message
deliverMessage( f );
} else {
// remember the frame whose payload is about to be continued
currentframe = f;
}
} else if( f.getOpcode() == Opcode.CONTINIOUS ) {
currentframe.append( f );
if( f.isFin() ) {
deliverMessage( currentframe );
currentframe = null;
}
} else {
throw new InvalidDataException( CloseFrame.PROTOCOL_ERROR, "non control or continious frame expected" );
}
}
}
} catch ( InvalidDataException e1 ) {
wsl.onWebsocketError( this, e1 );
close( e1 );
return;
}
}
}
}
// PUBLIC INSTANCE METHODS /////////////////////////////////////////////////
/**
* sends the closing handshake.
* may be send in response to an other handshake.
*/
public void close( int code, String message ) {
try {
closeDirect( code, message );
} catch ( IOException e ) {
closeConnection( CloseFrame.ABNROMAL_CLOSE, true );
}
}
public void closeDirect( int code, String message ) throws IOException {
if( !closeHandshakeSent ) {
if( handshakeComplete ) {
if( code == CloseFrame.ABNROMAL_CLOSE ) {
closeConnection( code, true );
closeHandshakeSent = true;
return;
}
flush();
if( draft.getCloseHandshakeType() != CloseHandshakeType.NONE ) {
try {
sendFrameDirect( new CloseFrameBuilder( code, message ) );
} catch ( InvalidDataException e ) {
wsl.onWebsocketError( this, e );
closeConnection( CloseFrame.ABNROMAL_CLOSE, "generated frame is invalid", false );
}
} else {
closeConnection( code, false );
}
} else if( code == CloseFrame.FLASHPOLICY ) {
closeConnection( CloseFrame.FLASHPOLICY, true );
} else {
closeConnection( CloseFrame.NEVERCONNECTED, false );
}
if( code == CloseFrame.PROTOCOL_ERROR )// this endpoint found a PROTOCOL_ERROR
closeConnection( code, false );
closeHandshakeSent = true;
return;
}
}
/**
* closes the socket no matter if the closing handshake completed.
* Does not send any not yet written data before closing.
* Calling this method more than once will have no effect.
*
* @param remote
* Indicates who "generated" <code>code</code>.<br>
* <code>true</code> means that this endpoint received the <code>code</code> from the other endpoint.<br>
* false means this endpoint decided to send the given code,<br>
* <code>remote</code> may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the <code>code</code> but close the connection the same time this endpoint does do but with an other <code>code</code>. <br>
**/
public void closeConnection( int code, String message, boolean remote ) {
if( connectionClosed ) {
return;
}
connectionClosed = true;
try {
sockchannel.close();
} catch ( IOException e ) {
wsl.onWebsocketError( this, e );
}
this.wsl.onWebsocketClose( this, code, message, remote );
if( draft != null )
draft.reset();
currentframe = null;
handshakerequest = null;
}
public void closeConnection( int code, boolean remote ) {
closeConnection( code, "", remote );
}
public void close( int code ) {
close( code, "" );
}
public void close( InvalidDataException e ) {
close( e.getCloseCode(), e.getMessage() );
}
/**
* Send Text data to the other end.
*
* @throws IllegalArgumentException
* @throws InterruptedException
* @throws NotYetConnectedException
*/
public boolean send( String text ) throws NotYetConnectedException , InterruptedException {
if( text == null )
throw new IllegalArgumentException( "Cannot send 'null' data to a WebSocket." );
return send( draft.createFrames( text, role == Role.CLIENT ) );
}
/**
* Send Binary data (plain bytes) to the other end.
*
* @throws IllegalArgumentException
* @throws InterruptedException
* @throws NotYetConnectedException
*/
public boolean send( ByteBuffer bytes ) throws IllegalArgumentException , NotYetConnectedException , InterruptedException {
if( bytes == null )
throw new IllegalArgumentException( "Cannot send 'null' data to a WebSocket." );
return send( draft.createFrames( bytes, role == Role.CLIENT ) );
}
public boolean send( byte[] bytes ) throws IllegalArgumentException , NotYetConnectedException , InterruptedException {
return send( ByteBuffer.wrap( bytes ) );
}
private boolean send( Collection<Framedata> frames ) throws InterruptedException {
if( !this.handshakeComplete )
throw new NotYetConnectedException();
for( Framedata f : frames ) {
if(!sendFrame( f )) return false;
}
return true;
}
public boolean sendFrame( Framedata framedata ) throws InterruptedException {
if( DEBUG )
System.out.println( "send frame: " + framedata );
return channelWrite( draft.createBinaryFrame( framedata ) );
}
private void sendFrameDirect( Framedata framedata ) throws IOException {
if( DEBUG )
System.out.println( "send frame: " + framedata );
channelWriteDirect( draft.createBinaryFrame( framedata ) );
}
boolean hasBufferedData() {
return !this.bufferQueue.isEmpty();
}
/**
* The amount of data in Queue, ready to be sent.
*
* @return Amount of Data still in Queue and not sent yet of the socket
*/
long bufferedDataAmount() {
return bufferQueueTotalAmount.get();
}
/**
* Empty the internal buffer, sending all the pending data before continuing.
*/
public void flush() throws IOException {
ByteBuffer buffer = this.bufferQueue.peek();
while ( buffer != null ) {
int written = sockchannel.write( buffer );
if( buffer.remaining() > 0 ) {
continue;
} else {
// subtract this amount of data from the total queued (synchronized over this object)
bufferQueueTotalAmount.addAndGet( -written );
this.bufferQueue.poll(); // Buffer finished. Remove it.
buffer = this.bufferQueue.peek();
}
}
}
public HandshakeState isFlashEdgeCase( ByteBuffer request ) {
if( request.limit() > Draft.FLASH_POLICY_REQUEST.length )
return HandshakeState.NOT_MATCHED;
else if( request.limit() < Draft.FLASH_POLICY_REQUEST.length ) {
return HandshakeState.MATCHING;
} else {
request.mark();
for( int flash_policy_index = 0 ; request.hasRemaining() ; flash_policy_index++ ) {
if( Draft.FLASH_POLICY_REQUEST[ flash_policy_index ] != request.get() ) {
request.reset();
return HandshakeState.NOT_MATCHED;
}
}
return HandshakeState.MATCHED;
// return request.remaining() >= Draft.FLASH_POLICY_REQUEST.length ? HandshakeState.MATCHED : HandshakeState.MATCHING;
}
}
public void startHandshake( ClientHandshakeBuilder handshakedata ) throws InvalidHandshakeException , InterruptedException {
if( handshakeComplete )
throw new IllegalStateException( "Handshake has already been sent." );
// Store the Handshake Request we are about to send
this.handshakerequest = draft.postProcessHandshakeRequestAsClient( handshakedata );
// Notify Listener
try {
wsl.onWebsocketHandshakeSentAsClient( this, this.handshakerequest );
} catch ( InvalidDataException e ) {
// Stop if the client code throws an exception
throw new InvalidHandshakeException( "Handshake data rejected by client." );
}
// Send
channelWrite( draft.createHandshake( this.handshakerequest, role ) );
}
private boolean channelWrite( ByteBuffer buf ) throws InterruptedException {
if( DEBUG )
System.out.println( "write(" + buf.remaining() + "): {" + ( buf.remaining() > 1000 ? "too big to display" : new String( buf.array() ) ) + "}" );
// add up the number of bytes to the total queued (synchronized over this object)
bufferQueueTotalAmount.addAndGet( buf.remaining() );
// If the buffer is full, don't block; just don't send the packet
if( !bufferQueue.offer( buf ) ) {
return false;
/*try {
flush();
} catch ( IOException e ) {
wsl.onWebsocketError( this, e );
closeConnection( CloseFrame.ABNROMAL_CLOSE, true );
return;
}
bufferQueue.put( buf );*/
}
wsl.onWriteDemand( this );
return true;
}
private void channelWrite( List<ByteBuffer> bufs ) throws InterruptedException {
for( ByteBuffer b : bufs ) {
channelWrite( b );
}
}
private void channelWriteDirect( ByteBuffer buf ) throws IOException {
while ( buf.hasRemaining() )
sockchannel.write( buf );
}
private void writeDirect( List<ByteBuffer> bufs ) throws IOException {
for( ByteBuffer b : bufs ) {
channelWriteDirect( b );
}
}
private void deliverMessage( Framedata d ) throws InvalidDataException {
if( d.getOpcode() == Opcode.TEXT ) {
wsl.onWebsocketMessage( this, Charsetfunctions.stringUtf8( d.getPayloadData() ) );
} else if( d.getOpcode() == Opcode.BINARY ) {
wsl.onWebsocketMessage( this, d.getPayloadData() );
} else {
if( DEBUG )
System.out.println( "Ignoring frame:" + d.toString() );
assert ( false );
}
}
private void open( Handshakedata d ) throws IOException {
if( DEBUG )
System.out.println( "open using draft: " + draft.getClass().getSimpleName() );
handshakeComplete = true;
wsl.onWebsocketOpen( this, d );
}
public InetSocketAddress getRemoteSocketAddress() {
return (InetSocketAddress) sockchannel.socket().getRemoteSocketAddress();
}
public InetSocketAddress getLocalSocketAddress() {
return (InetSocketAddress) sockchannel.socket().getLocalSocketAddress();
}
public boolean isConnecting() {
return ( !connectionClosed && !closeHandshakeSent && !handshakeComplete );
}
public boolean isOpen() {
return ( !connectionClosed && !closeHandshakeSent && handshakeComplete );
}
public boolean isClosing() {
return ( !connectionClosed && closeHandshakeSent );
}
public boolean isClosed() {
return connectionClosed;
}
/**
* Retrieve the WebSocket 'readyState'.
* This represents the state of the connection.
* It returns a numerical value, as per W3C WebSockets specs.
*
* @return Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'
*/
public int getReadyState() {
if( isConnecting() ) {
return READY_STATE_CONNECTING;
} else if( isOpen() ) {
return READY_STATE_OPEN;
} else if( isClosing() ) {
return READY_STATE_CLOSING;
} else if( isClosed() ) {
return READY_STATE_CLOSED;
}
assert ( false );
return -1; // < This can't happen, by design!
}
@Override
public int hashCode() {
return super.hashCode();
}
@Override
public String toString() {
return super.toString(); // its nice to be able to set breakpoints here
}
}