Add a c_api and build .so and .dll

Author: raffber

.github/workflows/ci.yml

@@ -45,5 +45,8 @@ jobs:
           name: comsrv
           path: |
             out/comsrv
+            out/libcomsrv.so
             out/comsrv.exe
+            out/comsrv.dll
+            out/comsrv.dll.lib
             out/*.whl

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.3.1] - unreleased
+
+### Added
+
+- Compile a C library for embedding in other application
+
 ## [2.3.0] - 2024-04-23
 
 ### Added

Cargo.lock

@@ -10,8 +10,11 @@ rm -rf target
 mv /cache/windows-release-cache target
 cargo build --release --target  x86_64-pc-windows-msvc
 cp target/x86_64-pc-windows-msvc/release/comsrv.exe out
+cp target/x86_64-pc-windows-msvc/release/comsrv.dll out
+cp target/x86_64-pc-windows-msvc/release/comsrv.dll.lib out
 
 rm -rf target
 mv /cache/linux-release-cache target
 cargo build --release
 cp target/release/comsrv out
+cp target/release/libcomsrv.so out

ci/build-ci.sh

@@ -1,6 +1,6 @@
 [package]
 name = "comsrv_client"
-version = "2.3.0"
+version = "2.3.1"
 edition = "2018"
 license = "MIT OR Apache-2.0"
 

client/Cargo.toml

@@ -1,10 +1,17 @@
 [package]
 name = "comsrv"
-version = "2.3.0"
+version = "2.3.1"
 authors = ["Raphael Bernhard <[email protected]>"]
 edition = "2018"
 license = "MIT OR Apache-2.0"
 
+[lib]
+crate-type = ["rlib", "cdylib"]
+
+[[bin]]
+name = "comsrv"
+path = "src/main.rs"
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
@@ -23,7 +30,7 @@ tokio = { version = "^1", features = [
     "macros",
     "rt-multi-thread",
 ] }
-broadcast_wsrpc = { git = "https://github.com/raffber/wsrpc.git", rev = "9565f8f03502e93c21e5159fba48e2779a429b2d" }
+broadcast_wsrpc = { git = "https://github.com/raffber/wsrpc.git", rev = "6c5fc98d0a51f2517e26d82dc8d9bb2343c02255" }
 clap = { version = "3", features = ["cargo"] }
 env_logger = "0.7.1"
 log = "0.4.11"

comsrv/Cargo.toml

@@ -150,7 +150,7 @@ impl App {
             Request::DropAll => self.drop_all().await,
             Request::Shutdown => {
                 let _ = self.drop_all();
-                self.server.shutdown().await;
+                self.server.shutdown();
                 Ok(Response::Done)
             }
             Request::ListHidDevices => hid::list_devices().await.map(|x| Response::Hid(HidResponse::List(x))),

comsrv/src/app.rs

@@ -0,0 +1,49 @@
+#![allow(unsafe_code)]
+
+use std::{net::SocketAddr, time::Duration};
+
+use tokio::runtime::Runtime;
+
+use crate::app::App;
+
+#[repr(C)]
+pub struct AppState {
+    app: *const App,
+}
+
+#[no_mangle]
+pub extern "C" fn comsrv_spawn() -> AppState {
+    let port = 5902;
+    let (tx, rx) = std::sync::mpsc::channel();
+
+    let rt = Runtime::new().unwrap();
+    rt.block_on(async move {
+        let (app, rx) = App::new();
+        let app = Box::new(app);
+        let ws_addr: SocketAddr = format!("127.0.0.1:{}", port).parse().unwrap();
+        let http_addr: SocketAddr = format!("127.0.0.1:{}", port + 1).parse().unwrap();
+        println!("Listening on ws://{}", ws_addr);
+        println!("Listening on http://{}", http_addr);
+        app.server.listen_ws(&ws_addr).await.unwrap();
+        app.server.listen_http(&http_addr).await;
+
+        let ret = AppState {
+            app: app.as_ref() as *const App,
+        };
+
+        tx.send(ret).unwrap();
+
+        app.run(rx).await;
+        std::mem::forget(app);
+        log::debug!("Application quitting.");
+    });
+
+    return rx.recv_timeout(Duration::from_secs(1)).expect("Failed to start comsrv");
+}
+
+#[no_mangle]
+pub extern "C" fn comsrv_stop(state: AppState) {
+    let app: &App = unsafe { &*state.app };
+    app.server.shutdown();
+    log::debug!("Application stopping.");
+}

comsrv/src/c_api.rs

@@ -8,6 +8,7 @@ extern crate lazy_static;
 pub use comsrv_protocol::{Request, Response};
 
 pub mod app;
+pub mod c_api;
 mod inventory;
 mod iotask;
 mod protocol;

comsrv/src/lib.rs

@@ -49,12 +49,15 @@ fn main() {
     rt.block_on(async move {
         let (app, rx) = App::new();
         app.server.enable_broadcast_reqrep(broadcast_reqrep);
-        let url = format!("0.0.0.0:{}", port);
+
+        let ws_addr: SocketAddr = format!("0.0.0.0:{}", port).parse().unwrap();
         let http_addr: SocketAddr = format!("0.0.0.0:{}", port + 1).parse().unwrap();
-        println!("Listening on ws://{}", url);
-        app.server.listen_ws(url).await;
+        println!("Listening on ws://{}", ws_addr);
         println!("Listening on http://{}", http_addr);
-        app.server.listen_http(http_addr).await;
+
+        app.server.listen_ws(&ws_addr).await.expect("Failed to listen on WebSocket");
+        app.server.listen_http(&http_addr).await;
+
         app.run(rx).await;
         log::debug!("Application quitting.");
     });

comsrv/src/main.rs

@@ -1,6 +1,6 @@
 name: comsrv
 description: Client implementation for comsrv
-version: 2.3.0
+version: 2.3.1
 homepage: https://github.com/raffber/comsrv
 publish_to: none
 

dart/comsrv/pubspec.yaml

@@ -1,6 +1,6 @@
 [package]
 name = "comsrv_protocol"
-version = "2.3.0"
+version = "2.3.1"
 authors = ["Raphael Bernhard <[email protected]>"]
 edition = "2018"
 license = "MIT OR Apache-2.0"

protocol/Cargo.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "comsrv"
-version = "2.3.0"
+version = "2.3.1"
 description = ""
 authors = ["Raphael Bernhard <[email protected]>"]
 packages = [{ include = "comsrv", from = "python" }]