2.4.0

Author: miktim

readme

@@ -6,7 +6,7 @@ Release notes:
   - supported WebSocket version: 13;
   - WebSocket extensions not supported;
   - supports TLS connections (without client auth and tunneling);
-  - stream-oriented messaging.
+  - stream-based messaging.
 
 Overview:
   Constructors:
@@ -61,8 +61,8 @@ Overview:
 //        - incoming messages are available until the closing handshake completed.
       WsStatus getStatus();
       String getSubProtocol(); // returns null or handshaked WebSocket subprotocol
-      boolean isOpen();   // connection is open
-      boolean isSecure(); // is TLS connection
+      boolean isOpen();     // connection is open
+      boolean isSecure();   // is TLS connection
       String getPeerHost(); // returns remote host name
       int getPort() // returns bound/connected port
       String getPath();  // returns http request path or null

src/org/miktim/websocket/WebSocket.java

@@ -1,16 +1,16 @@
 /*
  * WebSocket. MIT (c) 2020-2021 miktim@mail.ru
  *
- * Prepare ServerSocket/Socket (bind, connect).
- * Create and start listener/connection threads.
+ * Creates ServerSocket/Socket (bind, connect).
+ * Creates and starts listener/connection threads.
  *
  * Release notes:
  * - Java SE 7+, Android compatible;
  * - RFC-6455: https://tools.ietf.org/html/rfc6455;
  * - WebSocket protocol version: 13;
  * - WebSocket extensions not supported;
- * - plain socket/TLS connections;
- * - stream-oriented messaging.
+ * - supports plain socket/TLS connections;
+ * - stream-based messaging.
  *
  * Created: 2020-06-06
  */
@@ -36,14 +36,9 @@
 import javax.net.ssl.SSLServerSocketFactory;
 import javax.net.ssl.SSLSocket;
 import javax.net.ssl.SSLSocketFactory;
-//import javax.net.ssl.SSLSocket;
-//import javax.net.ssl.TrustManagerFactory;
 
 public class WebSocket {
 
-//    private int handshakeSoTimeout = WsConnection.DEFAULT_HANDSHAKE_SO_TIMEOUT; // open/close handshake
-//    private int connectionSoTimeout = WsConnection.DEFAULT_CONNECTION_SO_TIMEOUT;
-//    private boolean pingPong = true;
     private WsParameters wsp = new WsParameters();
     private InetAddress bindAddress;
     private final long wsId = (new Thread()).getId();

src/org/miktim/websocket/WsConnection.java

@@ -46,8 +46,8 @@ public class WsConnection extends Thread {
     public void send(InputStream is) throws IOException {
         syncSend(is, false);
     }
-// send UTF-8 text
 
+// send UTF-8 text
     public void send(Reader rd) throws IOException {
         syncSend(new ReaderInputStream(rd), true);
     }
@@ -189,7 +189,7 @@ private synchronized void syncSend(InputStream is, boolean isText)
                 sendFrame(op, buf, buf.length);
                 op = OP_CONTINUATION;
             }
-// be sure to send the final frame even if eof is detected!            
+// be sure to send the final frame even if eof is detected (payload length = 0)!            
             sendFrame(op | OP_FINAL, buf, len >= 0 ? len : 0);
         } catch (IOException e) {
             closeDueTo(WsStatus.INTERNAL_ERROR, e);
@@ -201,7 +201,8 @@ private synchronized void syncSend(InputStream is, boolean isText)
 // - the closing code outside 1000-4999 is replaced by 1005 (NO_STATUS)
 //   and the reason is ignored; 
 // - a reason that is longer than 123 bytes is truncated;
-// - closing the connection blocks sending messages (send methods throws IOException)
+// - closing the connection blocks outgoing messages (send methods throws IOException);
+// - incoming messages are available until the closing handshake completed.
     public void close() {
         close(WsStatus.NO_STATUS, "");
     }
@@ -428,7 +429,7 @@ public static String base64Encode(byte[] b) {
     static final byte[] PING_PAYLOAD = "PingPong".getBytes();
     static final byte[] EMPTY_PAYLOAD = new byte[0];
 
-// variables are filled with waitDataFrame()
+// variables are filled with waitDataFrame() function
     private int opData; // data frame opcode
     private final byte[] payloadMask = new byte[8]; // mask & temp buffer for payloadLength
     private long payloadLength = 0;
@@ -449,8 +450,8 @@ private void startMessaging() throws IOException {
         handler.onClose(this, getStatus());
     }
 
-    // Sets WsConnection properties: opData, payloadMask, payloadLegth
-    // Returns true when a data frame arrives
+// Sets WsConnection properties: opData, payloadMask, payloadLegth
+// Returns true when a data frame arrives
     private boolean waitDataFrame() {
         boolean maskedPayload;
         while (!status.clean) { // !closing hanshake completed
@@ -516,7 +517,7 @@ private boolean waitDataFrame() {
                         payloadLength += (payloadMask[i] & 0xFF);
                     }
                 }
-// get mask 
+// get payload mask 
                 maskedPayload = (b2 & MASKED_DATA) != 0;
                 if (maskedPayload) {
                     toRead = 4;
@@ -718,7 +719,7 @@ public void close() throws IOException {
                 this.state = IS_CLOSED;
             }
         }
-        /* ????     
+        /* ??? can speed up     
         @Override
         public int read(byte[] b, int off, int len) throws IOException {
            System.arraycopy 
@@ -773,7 +774,7 @@ private void umaskPayload(byte[] mask, byte[] payload, int len) {
 
     private synchronized void sendFrame(int opFrame, byte[] payload, int len)
             throws IOException {
-        if (status.code != 0) { // || !isSocketOpen()) {
+        if (status.code != 0) { // !isOpen()
 // WebSocket closed or close handshake in progress            
             throw new SocketException("WebSocket closed");
         }

src/org/miktim/websocket/WsHandler.java

@@ -17,8 +17,8 @@ public interface WsHandler {
     public void onOpen(WsConnection conn, String subProtocol);
 
 // onMessage:
-//   - WebSocket message presented by input stream of binary data or UTF-8 characters;    
-//   - exiting the handler closes the stream.
+// - the WebSocket message is represented by an input stream of binary data or UTF-8 characters;
+// - exiting the handler closes the stream.
     public void onMessage(WsConnection conn, InputStream is, boolean isUTF8Text);
 
 // onError:

src/org/miktim/websocket/WsListener.java

@@ -1,7 +1,7 @@
 /*
  * WsListener. WebSocket listener, MIT (c) 2020-2021 miktim@mail.ru
  *
- * Accept sockets, create and start connection threads.
+ * Accepts sockets, creates and starts connection threads.
  *
  * Created: 2020-03-09
  */

test/WssClientTest.java

@@ -1,5 +1,5 @@
 /*
- * WebSocket client test. (c) websocketstest.com
+ * Secure WebSocket client test. (c) websocketstest.com
  * Adapted by miktim@mail.ru, march 2021
  */
 
@@ -17,7 +17,7 @@
 public class WssClientTest {
 
     static final int MAX_MESSAGE_LENGTH = 10000; //
-    static final int WEBSOCKET_SHUTDOWN_TIMEOUT = 10000; //10sec 
+    static final int WEBSOCKET_SHUTDOWN_TIMEOUT = 15000; //10sec 
     static final String REMOTE_CONNECTION = "wss://websocketstest.com:443/service";//
 
     static String fragmentTest = randomString(512);

test/WssConnectionTest.java

@@ -13,7 +13,7 @@
 import org.miktim.websocket.WsListener;
 import org.miktim.websocket.WsParameters;
 import org.miktim.websocket.WsStatus;
- 
+
 public class WssConnectionTest {
 
     static final int MAX_MESSAGE_LENGTH = 1000000; //~1MB