WebSockets server in custom aplication Axis camera with OS version 12.00.XX

[yslavcom]

Hello all,
There is an example of web-server running in a custom application via proxy with Apache
https://github.com/AxisCommunications/acap-native-sdk-examples/blob/main/web-server/README.md

I would like to use Websockets Server in custom application on an Axis camera if it is possible.
mod_proxy_wstunnel is available on the device

find / -name "mod_proxy_wstunnel.so" 2>/dev/null
/usr/lib/apache2/modules/mod_proxy_wstunnel.so

Any hints how to setup manifest.json from the example above or any other way?

Update:
There is schema version 1.7.2 which mentioned Websockets under

apiType string Required
API protocol (http, web socket or fast cgi). Possible values: http, ws, fcgi

https://developer.axis.com/acap/develop/manifest-schemas/schema-field-descriptions-v1.7.3/

But I could not find any more detailed examples for Websockets on Axis camera

Update2:
I was able to implement Websockets server in a custom app with the following:
manifest json

{
    "schemaVersion": "1.7.2",
    "acapPackageConf": {
        "setup": {
            "appName": "hello_world",
            "vendor": "Axis Communications",
            "runMode": "never",
            "version": "0.1.0"
        },
		"configuration": {
            "reverseProxy": [
				{
                    "apiPath": "ws",
                    "apiType": "ws",
                    "target": "unix:/tmp/websocket_app.sock",
                    "access": "anonymous"
                  }
			]
        }
    }
}

in the app itself

let socket_path = "/tmp/websocket_app.sock";
let listener = UnixListener::bind(socket_path)?;
std::fs::set_permissions(socket_path, std::fs::Permissions::from_mode(0o666))?;

Webserver client uri:

let uri ="ws://<IP>/local/hello_world/ws";

Thank you

[yslavcom]

I was able to implement Websockets server in a custom app with the following:
manifest json

{
"schemaVersion": "1.7.2",
"acapPackageConf": {
"setup": {
"appName": "hello_world",
"vendor": "Axis Communications",
"runMode": "never",
"version": "0.1.0"
},
"configuration": {
"reverseProxy": [
{
"apiPath": "ws",
"apiType": "ws",
"target": "unix:/tmp/websocket_app.sock",
"access": "anonymous"
}
]
}
}
}

in the app itself

let socket_path = "/tmp/websocket_app.sock";
let listener = UnixListener::bind(socket_path)?;
std::fs::set_permissions(socket_path, std::fs::Permissions::from_mode(0o666))?;

Webserver client uri:

let uri ="ws:///local/hello_world/ws";

[janssen70]

Hi,

Adding for completeness that the 'target' to use in the manifest.json will depend on the backend-implementation. Above, an example is shown for an implementation that listens on unix socket. Here is another one, using uWebSockets as backend, communicating over internal network socket.

An excerpt of the uWebSockets url-routing config (where DIRECT_PREFIX is /local/yourappname), to get an idea:

int web_server(Application* backend_app)
{
    struct PerSocketData {
       /* Fill with user data */
    };
    LOG(LOG_INFO, "Embedded webserver started");
    backend_s = backend_app;

    uWS::App app = uWS::App()
    /*
     * Set/get parameters
     */
    .get(DIRECT_PREFIX "/api/settings", get_settings)
    .post(DIRECT_PREFIX "/api/settings", post_settings)
    .get(DIRECT_PREFIX "/api/versions", get_versions) /* Get detailed version information */
     .ws<PerSocketData>(DIRECT_PREFIX "/ws/status/", {
          /* Settings */
          .compression = uWS::SHARED_COMPRESSOR,
          .maxPayloadLength = 16 * 1024 * 1024,
          .idleTimeout = 16,
          .maxBackpressure = 1 * 1024 * 1024,
          .closeOnBackpressureLimit = false,
          .resetIdleTimeoutOnSend = false,
          .sendPingsAutomatically = true,
          /* Handlers */
          .upgrade = nullptr,
          .open = [](auto *ws) {
              /*
               * Open event here, you may access ws->getUserData() which points
               * to a PerSocketData struct
                */
              ws->subscribe("status");
          },
          .message = [](auto* /*ws*/, std::string_view /*message*/, uWS::OpCode /*opCode*/) {

          },
          .drain = [](auto* /*ws*/) {
              /* Check ws->getBufferedAmount() here */
          },
          .ping = [](auto* /*ws*/, std::string_view) {
              /* Not implemented yet */
          },
          .pong = [](auto* /*ws*/, std::string_view) {
              /* Not implemented yet */
          },
          .close = [](auto* /*ws*/, int /*code*/, std::string_view /*message*/) {
              /* You may access ws->getUserData() here */
          }
       }
    )
    .listen(
       PORT_NUMBER,
       [](auto *listen_socket)
       {
          if (listen_socket) {
              LOG(LOG_INFO, "Listening on port %i", PORT_NUMBER);
          }
       }
    );

And the proxy-part of the manifest as follows, to provide both an http- and websocket accesspoint that gets forwarded to the uWebsockets implementation:

"reverseProxy": [ {
      "apiPath": "api",
      "target": "http://localhost:3000",
      "access": "admin"
   },
  {
     "apiPath": "ws",
     "target": "ws://localhost:3000",
     "access": "admin"
 }],