Add AsyncSocket protocol

Author: weavejester

ring-core/src/ring/websocket.clj

@@ -28,6 +28,9 @@
   (-pong  [socket data])
   (-close [socket status reason]))
 
+(defprotocol AsyncSocket
+  (-send-async [socket message succeed fail]))
+
 (defprotocol TextData
   (->string [data]))
 
@@ -51,8 +54,11 @@
     :else (throw (ex-info "message is not a valid text or binary data type"
                           {:message message}))))
 
-(defn send [socket message]
-  (-send socket (encode-message message)))
+(defn send
+  ([socket message]
+   (-send socket (encode-message message)))
+  ([socket message succeed fail]
+   (-send-async socket (encode-message message) succeed fail)))
 
 (defn ping
   ([socket]

ring-jetty-adapter/src/ring/adapter/jetty.clj

@@ -26,15 +26,17 @@
             Session
             WebSocketConnectionListener
             WebSocketListener
-            WebSocketPingPongListener]
+            WebSocketPingPongListener
+            WriteCallback]
            [org.eclipse.jetty.websocket.server.config
             JettyWebSocketServletContainerInitializer]
            [jakarta.servlet AsyncContext DispatcherType AsyncEvent AsyncListener]
            [jakarta.servlet.http HttpServletRequest HttpServletResponse]))
 
 (defn- websocket-socket [^Session session]
   (let [remote (.getRemote session)]
-    (reify ws/Socket
+    (reify
+      ws/Socket
       (-send [_ message]
         (if (string? message)
           (.sendString remote message)
@@ -44,7 +46,15 @@
       (-pong [_ data]
         (.sendPong remote data))
       (-close [_ status reason]
-        (.close session status reason)))))
+        (.close session status reason))
+      ws/AsyncSocket
+      (-send-async [_ message succeed fail]
+        (let [callback (reify WriteCallback
+                         (writeSuccess [_] (succeed))
+                         (writeFailed [_ ex] (fail ex)))]
+          (if (string? message)
+            (.sendString remote message callback)
+            (.sendBytes remote message callback)))))))
 
 (defn- websocket-listener [listener]
   (let [socket (volatile! nil)]

ring-jetty-adapter/test/ring/adapter/test/jetty.clj

@@ -718,6 +718,28 @@
       (is (= [[:ping "foo"] [:pong "foo"]]
              @log))))
 
+  (testing "sending websocket messages asynchronously"
+    (let [log     (atom [])
+          handler (constantly
+                   {::ws/listener
+                    (reify ws/Listener
+                      (on-open [_ sock]
+                        (ws/send sock "Hello"
+                                 (fn [] (ws/send sock "World" (fn []) (fn [_])))
+                                 (fn [_])))
+                      (on-message [_ _ _])
+                      (on-pong [_ _ _])
+                      (on-error [_ _ _])
+                      (on-close [_ _ _ _]))})]
+      (with-server handler {:port test-port}
+        (let [ws @(hato/websocket test-websocket-url
+                                  {:on-message
+                                   (fn [_ msg _] (swap! log conj (str msg)))})]
+          (Thread/sleep 100)
+          @(hato/close! ws)
+          (Thread/sleep 100)))
+      (is (= ["Hello" "World"] @log))))
+
   (testing "using a map as a listener"
     (let [listener {:on-open (fn [s] [:on-open s])
                     :on-message (fn [s m] [:on-message s m])