NAME

zerodds-ws-bridged - DDS to WebSocket bridge daemon

SYNOPSIS

zerodds-ws-bridged [--config FILE] [--listen ADDR] [--domain ID] [--topic NAME]... [--log-level LEVEL] [--metrics ADDR] [-V | --version] [-h | --help]

DESCRIPTION

zerodds-ws-bridged exposes selected DDS topics to WebSocket clients and forwards inbound WS messages onto matching DDS publishers. It is the reference DDS ↔︎ WS bridge for the ZeroDDS distribution and implements docs/specs/zerodds-ws-bridge-1.0.md.

The daemon reads the YAML file given with --config, with drop-ins in its sibling FILE.d/; without that option it reads the system file /etc/zerodds/ws-bridged.yaml with /etc/zerodds/ws-bridged.d/ (on macOS under /usr/local/etc/zerodds) when it exists, and the built-in defaults otherwise. On Linux it integrates with systemd(1) via Type=notify; on macOS with launchd(8); on Windows it runs as service ZeroDDSWSBridge.

OPTIONS

--config=FILE

Path to the YAML configuration. See zerodds-ws-bridged.yaml(5).

--listen=ADDR

Bind address. Default: 0.0.0.0:8080.

--domain=ID

DDS domain id. Default: 0.

--topic=NAME

Single-topic override (repeatable).

--tls-cert=FILE

TLS cert (PEM); enables wss://.

--tls-key=FILE

TLS key (PEM).

--auth-token=SECRET

Bearer token auth.

--log-level=LEVEL

Override the configured log level. One of trace, debug, info, warn, error. Default: info.

--metrics=ADDR

Prometheus scrape endpoint.

-V, --version

Version info.

-h, --help

Print full option synopsis.

--set PATH=VALUE

One setting above every file, repeatable; +PATH=VALUE appends to a list.

--check-config

Validate and print the effective configuration with the origin of every value, then exit: 0 valid, 1 invalid value or unknown key, 2 unreadable file, syntax error or include cycle.

SIGNALS

SIGTERM

Graceful shutdown (drain in-flight WS frames, unregister DDS readers).

SIGHUP

Reads the configuration again: the TLS certificate and key files at their configured paths, the auth settings and the topic ACL apply from then on (the certificate to new connections). Changed TLS file paths, topics, listen address or domain need a restart and are logged. A configuration that does not load changes nothing.

ENVIRONMENT

OTEL_EXPORTER_OTLP_ENDPOINT

Optional OTLP endpoint, such as http://localhost:4318.

EXIT STATUS

0

Normal shutdown (SIGTERM/SIGINT).

1

Configuration error.

2

Bind error — address in use.

3

DDS discovery error.

4

TLS error.

FILES

/etc/zerodds/ws-bridged.yaml

Suggested deployment path, loaded only when selected with --config. Documented in zerodds-ws-bridged.yaml(5).

/var/log/zerodds/ws-bridged.log

Log target when logging.destination is file:....

/var/lib/zerodds/

Persistent state (route shadows, durable WS session ids).

SEE ALSO

zerodds-ws-bridged.yaml(5), zerodds-mqtt-bridged(1), zerodds-admin(1), systemd.service(5).

STANDARDS

DDS 1.4, RTPS 2.5, XTypes 1.3, RFC 6455 (WebSocket), RFC 7692 (permessage-deflate).

AUTHORS

ZeroDDS Contributors <release@zerodds.org>.

BEZEICHNUNG

zerodds-ws-bridged - Bridge-Daemon von DDS nach WebSocket

ÜBERSICHT

zerodds-ws-bridged [--config DATEI] [--listen ADR] [--domain ID] [--topic NAME]... [--log-level STUFE] [--metrics ADR] [-V | --version] [-h | --help]

BESCHREIBUNG

zerodds-ws-bridged stellt ausgewählte DDS-Topics für WebSocket-Clients bereit und leitet eingehende WS-Nachrichten an passende DDS-Publisher weiter. Es ist die Referenz-Bridge DDS ↔︎ WS der ZeroDDS-Distribution und implementiert docs/specs/zerodds-ws-bridge-1.0.md.

Der Daemon liest die YAML-Datei, die mit --config angegeben ist, mit Drop-ins im danebenliegenden DATEI.d/; ohne diese Option liest er die Systemdatei /etc/zerodds/ws-bridged.yaml mit /etc/zerodds/ws-bridged.d/ (unter macOS unter /usr/local/etc/zerodds), wenn es sie gibt, und sonst die eingebauten Standardwerte. Unter Linux bindet er sich über Type=notify an systemd(1) an, unter macOS an launchd(8); unter Windows läuft er als Dienst ZeroDDSWSBridge.

OPTIONEN

--config=DATEI

Pfad zur YAML-Konfiguration. Siehe zerodds-ws-bridged.yaml(5).

--listen=ADR

Bind-Adresse. Standard: 0.0.0.0:8080.

--domain=ID

DDS-Domain-ID. Standard: 0.

--topic=NAME

Überschreibung für ein einzelnes Topic (wiederholbar).

--tls-cert=DATEI

TLS-Zertifikat (PEM); schaltet wss:// ein.

--tls-key=DATEI

TLS-Schlüssel (PEM).

--auth-token=GEHEIMNIS

Authentifizierung mit Bearer-Token.

--log-level=STUFE

Überschreibt die konfigurierte Log-Stufe. Eine von trace, debug, info, warn, error. Standard: info.

--metrics=ADR

Abruf-Endpunkt für Prometheus.

-V, --version

Versionsangabe.

-h, --help

Gibt die vollständige Übersicht der Optionen aus.

--set PFAD=WERT

Eine Einstellung über allen Dateien, wiederholbar; +PFAD=WERT hängt an eine Liste an.

--check-config

Prüft die wirksame Konfiguration und gibt sie mit der Herkunft jedes Werts aus, dann Ende: 0 gültig, 1 ungültiger Wert oder unbekannter Schlüssel, 2 nicht lesbare Datei, Syntaxfehler oder Include-Zyklus.

SIGNALE

SIGTERM

Geordnetes Beenden (WS-Frames in Übertragung abarbeiten, DDS-Reader abmelden).

SIGHUP

Liest die Konfiguration neu: Die TLS-Zertifikats- und -Schlüsseldateien an ihren konfigurierten Pfaden, die Authentifizierungs-Einstellungen und die Topic-ACL gelten ab dann (das Zertifikat für neue Verbindungen). Geänderte TLS-Dateipfade, Topics, Listen-Adresse oder Domäne brauchen einen Neustart und werden protokolliert. Eine Konfiguration, die nicht lädt, ändert nichts.

UMGEBUNGSVARIABLEN

OTEL_EXPORTER_OTLP_ENDPOINT

Optionaler OTLP-Endpunkt, etwa http://localhost:4318.

EXIT-STATUS

0

Normales Beenden (SIGTERM/SIGINT).

1

Konfigurationsfehler.

2

Bind-Fehler — Adresse belegt.

3

Fehler bei der DDS-Discovery.

4

TLS-Fehler.

DATEIEN

/etc/zerodds/ws-bridged.yaml

Vorgeschlagener Pfad für das Deployment, nur geladen, wenn mit --config ausgewählt. Dokumentiert in zerodds-ws-bridged.yaml(5).

/var/log/zerodds/ws-bridged.log

Log-Ziel, wenn logging.destination gleich file:... ist.

/var/lib/zerodds/

Dauerhafter Zustand (Routen-Schatten, dauerhafte WS-Sitzungs-IDs).

SIEHE AUCH

zerodds-ws-bridged.yaml(5), zerodds-mqtt-bridged(1), zerodds-admin(1), systemd.service(5).

STANDARDS

DDS 1.4, RTPS 2.5, XTypes 1.3, RFC 6455 (WebSocket), RFC 7692 (permessage-deflate).

AUTOREN

ZeroDDS Contributors <release@zerodds.org>.