Crate oa_gateway_owp

Source
Expand description

OWP 1.0 adapter: WebSocket text frames in, oa_gateway_core::Envelope out.

This crate is a server. Clients speak OWP over a text WebSocket; the codec follows OMSC-SPC-013 and does not compile UCI. Conversion and validation happen in the session when a schema and xml_baseline are configured. The engine sees only envelopes.

OwpAdapter::run binds OwpConfig::bind and accepts until cancelled. A failed bind is fatal for this adapter only.

Modules§

  • codec 🔒
    OWP 1.0 text-frame codec. Grammar follows OMSC-SPC-013; no UCI types.
  • config 🔒
    Listen address, INIT identity, and resource limits.
  • convert 🔒
    JSON ↔ XML at the socket, plus A-GRA EncodedPayload hex.
  • server 🔒
    Accept loop and WebSocket handshake. Sessions live in session.
  • session 🔒
    One WebSocket session: INIT, then PUB / SUB / UNSUB until close.

Structs§

Enums§

  • ClientOp
    A parsed client frame.
  • OwpError
    Protocol error name carried on -ERR.
  • ServerOp
    A parsed server frame, or one about to be written.

Constants§

  • DEFAULT_IDLE_TIMEOUT_SECS
    Seconds with no frame in either direction on an active session before it is closed. Generous, since a subscriber to a low-rate topic is legitimately quiet on the inbound side and the server’s own MSG frames keep it alive.
  • DEFAULT_INIT_TIMEOUT_SECS
    Seconds from an accepted WebSocket to a successful INIT before the session is closed. Without it a peer can hold a connection slot forever by connecting and never speaking OWP.
  • DEFAULT_MAX_CONNECTIONS
    Concurrent connections accepted before further ones are refused.
  • DEFAULT_MAX_FRAME_SIZE
    Largest OWP frame accepted from a client, in bytes.
  • DEFAULT_MAX_SUBSCRIPTIONS
    Subscriptions allowed on one connection.

Functions§