Concurrency support via io_uring

CONTRIBUTING.md

@@ -1,19 +1,25 @@
 # Contributing Guide
 
-## Install and upgrade Magic
+## Activate the magic shell
+
+For development, you can activate the magic shell by running:
 
 ```bash
-magic update && magic install
+magic shell
 ```
 
 ## How to build this package
 
+Once you have the magic shell activated, you can build the package by running:
+
 ```bash
-mojo package src/websockets -o websockets.mojopkg
-``
+./scripts/build.sh
+```
 
 ## How to run tests
 
+To run the tests, you can run:
+
 ```bash
 ./scripts/run-tests.sh
 ```

README.md

@@ -1,8 +1,8 @@
-# mojo-websockets
+# Mojo Websockets
 
 ![logo](./assets/logo.jpeg)
 
-`mojo-websockets` is a lightweight library for handling WebSocket connections in Mojo. 
+`mojo-websockets` is a lightweight library for handling WebSocket connections in Mojo.
 
 It aims to provide an similar interface as the [python-websockets](https://github.com/python-websockets/websockets) package for creating WebSocket servers and clients, with additional features for enhanced usability.
 
@@ -13,6 +13,7 @@ This software is in a early stage of development. Please DO NOT use yet for prod
 ## Features
 
 - **WebSocket Server and Client**: Supports creating both WebSocket servers and clients.
+- **Asynchronous non-blocking communication**: Support concurrent connections via [io_uring](https://unixism.net/loti/).
 - **Compatibility**: API designed to be intuitive for developers familiar with the Python websockets library.
 - **Sans/IO Layer**: Implements a WebSocket Sans/IO layer pure Mojo and performs no I/O of its own.
 
@@ -34,16 +35,13 @@ For a complete listing, see the [features](docs/features.md) document.
 ```mojo
 from websockets.aliases import Bytes
 from websockets.sync.server import serve, WSConnection
-from websockets.utils.bytes import bytes_to_str
-
 
 fn on_message(conn: WSConnection, data: Bytes) raises -> None:
-    str_received = bytes_to_str(data)
+    str_received = String(StringSlice.from_utf8(data))
     print("<<< ", str_received)
     conn.send_text(str_received)
     print(">>> ", str_received)
 
-
 fn main() raises:
     with serve(on_message, "127.0.0.1", 8000) as server:
         server.serve_forever()
@@ -53,15 +51,13 @@ fn main() raises:
 
 ```mojo
 from websockets.sync.client import connect
-from websockets.utils.bytes import bytes_to_str
-
 
 fn send_and_receive(msg: String) raises:
     with connect("ws://127.0.0.1:8000") as client:
         client.send_text(msg)
         print(">>> ", msg)
-        response = client.recv()
-        print("<<< ", bytes_to_str(response))
+        response = client.recv_text()
+        print("<<< ", response)
 
 fn main() raises:
     send_and_receive("Hello world!")
@@ -70,9 +66,7 @@ fn main() raises:
 
 ## TODO
 
-- [ ] Asynchronous non-blocking communication (waiting for the Mojo async/await support)
 - [ ] Implement automatic reconnection for clients
-- [ ] Get rid of Python dependencies and logic (e.g. no more `from python import ...`)
 - [ ] Make sure it passes all the tests in [Autobahn|Testsuite](https://github.com/crossbario/autobahn-testsuite/)
 - [ ] Implement subprotocols and extensions
 - [ ] Optimize performance for high-concurrency scenarios
@@ -86,9 +80,9 @@ Contributions are welcome! If you'd like to contribute, please follow the contri
 
 ## Acknowledgments
 
-We have taken a lot of code from the amazing [lightbug_http](https://github.com/saviorand/lightbug_http) project.
-
-Also, we took inspiration and some code from the [python-websockets](https://github.com/websockets) project, specially for implementing the [WebSocket Sans/IO layer](https://websockets.readthedocs.io/en/stable/howto/sansio.html) and their tests.
+* We have taken a lot of code from the amazing [lightbug_http](https://github.com/saviorand/lightbug_http) project.
+* We took inspiration and some code from the [python-websockets](https://github.com/websockets) project, specially for implementing the [WebSocket Sans/IO layer](https://websockets.readthedocs.io/en/stable/howto/sansio.html) and their tests.
+* We are using the [io_uring](https://github.com/dmitry-salin/io_uring/) library for the I/O operations concurrency.
 
 ## License
 

examples/echo/client.mojo

@@ -1,16 +1,20 @@
 """Client example using the threading API."""
+
+import sys
+
 from websockets.sync.client import connect
-from websockets.utils.bytes import bytes_to_str, str_to_bytes
 
 
 fn send_and_receive_loop() raises:
-    with connect("ws://127.0.0.1:8001") as client:
+    args = sys.argv()
+    port = Int(args[1]) if len(args) > 1 else 8001
+    with connect("ws://127.0.0.1:{}".format(port)) as client:
         while True:
             msg = input("Enter a message: ")
             client.send_text(msg)
             print(">>> ", msg)
-            response = client.recv()
-            print("<<< ", bytes_to_str(response))
+            response = client.recv_text()
+            print("<<< ", response)
 
 
 fn main() raises:

examples/echo/run_client.sh

@@ -1,3 +1,5 @@
 #!/usr/bin/env bash
 
-mojo -I ../../src/ client.mojo
+cd "$(dirname "$0")"
+# Run with debug logging enabled
+mojo -I ../../src/ -D LOG_LEVEL=DEBUG client.mojo "$@"

examples/echo/run_server.sh

@@ -1,3 +1,5 @@
 #!/usr/bin/env bash
 
-mojo -I ../../src/ server.mojo
+cd "$(dirname "$0")"
+# Run with debug logging enabled
+mojo -I ../../src/ -D LOG_LEVEL=DEBUG server.mojo "$@"

examples/echo/server.mojo

@@ -1,19 +1,23 @@
-"""Server example using the threading API."""
+"""WebSocket server example using io_uring for concurrency."""
+
+import sys
+from utils import StringSlice
 
 from websockets.aliases import Bytes
 from websockets.sync.server import serve, WSConnection
-from websockets.utils.bytes import bytes_to_str
 
 
 fn on_message(conn: WSConnection, data: Bytes) raises -> None:
-    str_received = bytes_to_str(data)
+    str_received = String(StringSlice.from_utf8(data))
     print("<<< ", str_received)
     conn.send_text(str_received)
     print(">>> ", str_received)
 
 
 fn main() raises:
-    with serve(on_message, "127.0.0.1", 8001) as server:
+    print("Starting WebSocket echo server with io_uring concurrency support")
+    print("Multiple clients can connect simultaneously")
+    args = sys.argv()
+    port = Int(args[1]) if len(args) > 1 else 8001
+    with serve(on_message, "127.0.0.1", port) as server:
         server.serve_forever()
-
-