rvoip — universal real-time gateway facade

rvoip is the facade for the workspace's shared conversation model and transport adapters. It always provides the transport-independent Orchestrator and the Conversation/Session/Connection/Stream/ Message/Participant types, defaults to the SIP product, and lets applications opt into WebRTC, UCTP, Vapi voice agents, client, application-builder, and conversation-extension surfaces.

Unified 0.3.8 release train. The sip feature is the release-gated beta surface. Other facade features are available today as developer previews: they are implemented and published, but API-unstable or outside the SIP beta attestation. Publication requires fresh strict full-beta evidence bound to the exact clean 0.3.8 release source; historical exception and carry-forward reports do not qualify this train. Breaking changes remain possible before 1.0.

Quick start

The default feature is sip:

[dependencies]
rvoip = "0.3.8"

The shared orchestrator is available with every feature combination:

use rvoip::{Config, Orchestrator};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let orchestrator = Orchestrator::new(Config::default());

    // Construct enabled transport adapters and register them with:
    // orchestrator.register(adapter)?;

    let mut events = orchestrator.subscribe_events();
    while let Ok(event) = events.recv().await {
        // Route, bridge, or handle the conversation event.
        drop(event);
    }
    Ok(())
}

For the fastest path to a SIP endpoint, use rvoip-sip directly. Its Endpoint, StreamPeer, CallbackPeer, and UnifiedCoordinator APIs are also re-exported through rvoip::sip when the default sip feature is enabled.

Cargo features

This table mirrors crates/rvoip/Cargo.toml.

Examples:

# Shared conversation model plus SIP, WebRTC, UCTP, vCon, identity, and AI.
rvoip = { version = "0.3.8", features = ["voip-3"] }

# High-level cross-transport application builder.
rvoip = { version = "0.3.8", features = ["app"] }

# Every facade-owned feature.
rvoip = { version = "0.3.8", features = ["full"] }

full means every facade feature, not every crate in the rvoip workspace.

Module layout

Extension routing

Some extensions are re-exported by facade features; deployment-specific providers stay separate so protocol applications do not pull in backends they do not use.

For example:

[dependencies]
rvoip = { version = "0.3.8", features = ["sip"] }
rvoip-keycloak = "0.3.8"
rvoip-redis = "0.3.8"
rvoip-audit = "0.3.8"

Specialized workspace products

These products ship in the unified 0.3.8 train but are intentionally not facade feature flags:

High-level gateway builder

Enable app to declare transports, roles, assignment, and callbacks through one builder:

rvoip = { version = "0.3.8", features = ["app"] }

use rvoip::app::*;

# async fn run() -> rvoip::app::AppResult<()> {
let app = RvoipApp::builder()
    .webrtc(
        WebRtcConfig::ws("127.0.0.1:8081")
            .allow(Role::Customer, [Capability::Text, Capability::Voice]),
    )
    .sip(
        SipConfig::bind("127.0.0.1:5060")
            .domain("callcenter.local")
            .allow(Role::Employee, [Capability::Voice])
            .registrar_users([("alice", "password123")]),
    )
    .employees(EmployeePolicy::named(["alice"]))
    .customers(CustomerPolicy::webrtc_only())
    .assignment(AssignmentPolicy::fixed("alice"))
    .on_message(|ctx, msg| async move {
        ctx.reply("Alice", format!("Alice received: {}", msg.text))
            .await
    })
    .build()
    .await?;

app.run().await
# }

See the repository's 12-customer-escalation-sip-webrtc example for a complete cross-transport application.

Maturity boundaries

• SIP beta evidence does not qualify WebRTC, UCTP, MoQ, Amazon Connect, or extension products.
• WebRTC includes ICE and DTLS-SRTP; that does not make them SIP beta capabilities.
• Published developer-preview crates are available to build with now, but do not carry a blanket production-readiness or API-compatibility guarantee.
• Product READMEs define exact supported scope, configuration, and non-claims.

Documentation

• Workspace overview and complete extension catalog
• Facade API
• SIP API
• SIP beta evidence
• Architecture and protocol design

License

Licensed under the MIT License.