Struct ProbeBackend 

pub struct ProbeBackend { /* private fields */ }

Reachability backend: ICMP ping, TCP connect, TLS handshake, HTTP HEAD, and traceroute. All methods are synchronous.

Implementations

impl ProbeBackend

pub fn new() -> Self

Detect available capabilities and return a new backend.

Examples found in repository

examples/trace.rs (line 13)

fn main() {
    let target = std::env::args().nth(1).unwrap_or_else(|| "1.1.1.1".into());
    let ip: IpAddr = target.parse().expect("pass an IP literal");
    let b = ProbeBackend::new();
    println!("caps = {:?}", b.capabilities());

    println!("--- ping {ip} ---");
    let r = b
        .ping(
            ip,
            PingOpts {
                count: 3,
                timeout: Duration::from_millis(1000),
            },
        )
        .expect("ping");
    println!(
        "sent={} recv={} min={:?} avg={:?} max={:?}",
        r.sent, r.received, r.rtt_min, r.rtt_avg, r.rtt_max
    );

    println!("--- trace {ip} ---");
    let hops = b
        .trace(
            ip,
            TraceOpts {
                max_hops: 15,
                timeout_per_hop: Duration::from_millis(1000),
                proto: L4Proto::Tcp,
            },
        )
        .expect("trace");
    for h in &hops {
        println!(
            "  {:2} {:>20} {:>10}",
            h.ttl,
            h.ip.map(|i| i.to_string()).unwrap_or_else(|| "*".into()),
            h.rtt
                .map(|d| format!("{:.1}ms", d.as_secs_f64() * 1000.0))
                .unwrap_or_else(|| "-".into())
        );
    }
}

Trait Implementations

impl Default for ProbeBackend

fn default() -> Self

Returns the “default value” for a type.

impl Reachability for ProbeBackend

fn ping(&self, ip: IpAddr, opts: PingOpts) -> NcResult<PingResult>

Send ICMP echo requests to ip according to opts.

fn tcp_connect( &self, sa: SocketAddr, timeout: Duration, ) -> NcResult<TcpProbeResult>

Attempt a TCP three-way handshake to sa within timeout.

fn tls_handshake( &self, sa: SocketAddr, sni: &str, timeout: Duration, ) -> NcResult<TlsProbeResult>

Perform a TLS handshake to sa with the given SNI within timeout.

fn http_head(&self, url: &Url, timeout: Duration) -> NcResult<HttpProbeResult>

Issue an HTTP HEAD request to url within timeout.

fn trace(&self, ip: IpAddr, opts: TraceOpts) -> NcResult<Vec<Hop>>

Run a traceroute to ip using opts.

fn capabilities(&self) -> ProbeCapabilities

What this backend can actually do on this system.