ringo-agent 0.2.6

Run a SIP user agent as its own process, driven over a framed stdio protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//! Run a SIP user agent as its own process, driven over a framed stdio protocol
//! (length-prefixed JSON control frames interleaved with raw PCM audio frames).
//!
//! A consumer drives an agent via [`ProcessClient`] (spawned with
//! [`ProcessClient::spawn`]), which forks a child that re-execs the host
//! binary's `agent` subcommand — the host wires that subcommand to
//! [`worker::run`]. Each agent is its own process, with its own SIP socket and
//! media stack, so several can run side by side without sharing the SIP stack's
//! process-global state — which a single shared process can't do once incoming
//! calls must each be routed to the right agent.
//!
//! Public surface: [`ProcessClient`] + [`AgentConfig`] to drive an agent,
//! [`worker::run`] (the worker entry the host re-execs), and [`audio`] (tone
//! analysis / WAV helpers). The framed wire protocol is an internal detail.

#![warn(missing_docs)]

pub mod audio;
pub mod worker;
// The framed wire protocol and the parent-side client are implementation
// details: consumers drive an agent through the re-exported `ProcessClient`
// (with `AgentConfig`), never the wire types directly.
pub(crate) mod client;
pub(crate) mod proto;

pub use client::{ProcessClient, SavedAudio};
pub use proto::AgentConfig;
/// Re-exported so a consumer of [`ProcessClient::start_rx_audio`] can name the
/// streamed frame type without also depending on `ringo-core`.
pub use ringo_core::AudioFrame;