zeptoclaw 0.9.0

Ultra-lightweight personal AI assistant
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
31
32

//! Tunnel provider trait and types.
//!
//! Defines the `TunnelProvider` async trait for exposing local ports
//! via public tunnel URLs (Cloudflare, ngrok, Tailscale, etc.).

use async_trait::async_trait;

use crate::error::Result;

/// Trait implemented by all tunnel providers.
///
/// Each provider manages a child process that creates a public URL
/// pointing to a local port. The lifecycle is: `start()` -> use URL -> `stop()`.
#[async_trait]
pub trait TunnelProvider: Send + Sync {
    /// Human-readable provider name (e.g., "cloudflare", "ngrok", "tailscale").
    fn name(&self) -> &str;

    /// Start the tunnel and return the public URL.
    ///
    /// Spawns the provider binary, waits for it to output a URL,
    /// and returns the public endpoint.
    async fn start(&mut self, local_port: u16) -> Result<String>;

    /// Stop the tunnel and clean up resources.
    ///
    /// Kills the child process and performs any provider-specific teardown.
    async fn stop(&mut self) -> Result<()>;

    /// Check whether the tunnel process is still alive and healthy.
    async fn health_check(&self) -> Result<bool>;
}