HTTP: replacing wsConnect with wsClient (to be able to close the client connection)

Author: nmaguiar

src/openaf/plugins/HTTP.java

@@ -367,6 +367,39 @@ public Object wsConnect(String anURL, NativeFunction onConnect, NativeFunction o
 		return WebSockets.wsConnect(authenticator, l, p, anURL, onConnect, onMsg, onError, onClose, aTimeout, supportSelfSigned);
 	}
 
+	/**
+	 * <odoc>
+	 * <key>HTTP.wsClient(anURL, onConnect, onMsg, onError, onClose, aTimeout, supportSelfSigned) : WebSocketsReply</key>
+	 * Tries to establish a websocket connection (ws or wss) and returns a jetty WebSocketClient java object.
+	 * As callbacks you should defined onConnect, onMsg, onError and onClose. The onConnect callback will 
+	 * provide, as argument, the created session that you should use to send data; the onMsg callback will
+	 * provide, as arguments, aType (either "text" or "bytes"), aPayload (string or array of bytes) and an offset
+	 * and length (in case type is "bytes"); the onError callback will provide the cause; the onClose callback
+	 * will provide aStatusCode and aReason. You can optionally provide aTimeout (number) and indicate if self signed SSL
+	 * certificates should be accepted (supportSelfSigned = true). Example:\
+	 * \
+	 * plugin("HTTP");\
+	 * var session; var output = "";\
+	 * var res = (new HTTP()).wsClient("ws://echo.websocket.org",\
+	 *   function(aSession) { log("Connected"); session = aSession; },\
+	 *   function(aType, aPayload, aOffset, aLength) { if (aType == "text") output += aPayload; },\
+	 *   function(aCause) { logErr(aCause); },\
+	 *   function(aStatusCode, aReason) { log("Closed (" + aReason + ")"); }\
+	 * );\
+	 * session.getRemote().sendString("Hello World!");\
+	 * while(output.length &lt; 1) { sleep(100); };\
+	 * res.client.stop();\
+	 * print(output);\
+	 * \
+	 * NOTE: this functionality is only available if used with JVM >= 1.8\
+	 * \
+	 * </odoc>
+	 */
+	@JSFunction
+	public Object wsClient(String anURL, NativeFunction onConnect, NativeFunction onMsg, NativeFunction onError, NativeFunction onClose, Object aTimeout, boolean supportSelfSigned) throws Exception {
+		return WebSockets.wsClient(authenticator, l, p, anURL, onConnect, onMsg, onError, onClose, aTimeout, supportSelfSigned);
+	}
+
 	/**
 	 * 
 	 * @param aURL

src/openaf/plugins/HTTPws/WebSockets.java

@@ -15,12 +15,23 @@
 
 /**
  * HTTP plugin websockets extension
- * @author Nuno Aguiar <[email protected]>
+ * @author Nuno Aguiar
  */
 
 public class WebSockets {
+    static public class WebSocketsReply {
+        public org.eclipse.jetty.websocket.client.WebSocketClient client;
+        public Future<org.eclipse.jetty.websocket.api.Session> fut;
+    }
+
     static public Object wsConnect(Authenticator authenticator, String u, String p, String anURL, NativeFunction onConnect, NativeFunction onMsg, NativeFunction onError,
             NativeFunction onClose, Object aTimeout, boolean supportSelfSigned) throws Exception {
+        Object res = wsClient(authenticator, u, p, anURL, onConnect, onMsg, onError, onClose, aTimeout, supportSelfSigned);
+        return ((WebSocketsReply) res).fut;
+    }
+
+    static public Object wsClient(Authenticator authenticator, String u, String p, String anURL, NativeFunction onConnect, NativeFunction onMsg, NativeFunction onError,
+            NativeFunction onClose, Object aTimeout, boolean supportSelfSigned) throws Exception {
 
         class EventSocket extends org.eclipse.jetty.websocket.api.WebSocketAdapter {
             NativeFunction onConnect, onMsg, onError, onClose;
@@ -161,7 +172,11 @@ public void onWebSocketError(Throwable cause) {
             else
                 session = fut.get();
 
-            return fut;
+            WebSocketsReply res = new WebSocketsReply();
+            res.fut = fut;
+            res.client = client;
+
+            return res;
         } catch (Exception e) {
             client.stop();
             throw e;

tests/autoTestAll.HTTP.js

@@ -39,14 +39,15 @@
     exports.testHTTPWSClient = function() {
         plugin("HTTP");
         var session; var output = "";
-        var client = (new HTTP()).wsConnect("ws://echo.websocket.org",
+        var res = (new HTTP()).wsClient("ws://echo.websocket.org",
             function(aSession) { session = aSession; },
             function(aType, aPayload, aOffset, aLength) { if (aType == "text") output += aPayload; },
             function(aCause) { },
             function(aStatusCode, aReason) { });
         session.getRemote().sendString("Hello World!");
-        while(output.length < 1) { sleep(100); };
+        while(output.length < 1) { res.fut.get(); sleep(100); };
         session.stop();
+        res.client.stop();
 
         ow.test.assert(output, "Hello World!", "Problem with testing websockets against echo.websocket.org");    
     };