zpinger 0.6.0

Async, protocol-agnostic latency probe library: TCP / UDP / HTTP(S) / WebSocket / DNS / MQTT / gRPC / HLS
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Shared utilities used by every protocol module that drives a
//! socket directly (everything except `grpc`, which lets tonic handle
//! its own timeouts). Gated on the union of the protocol features
//! that actually call `with_timeout` so the `--no-default-features`
//! build doesn't warn about dead code.

#[cfg(any(
    feature = "tcp",
    feature = "udp",
    feature = "dns",
    feature = "http",
    feature = "ws",
    feature = "mqtt",
    feature = "hls",
))]
use std::io::{self, Result};
#[cfg(any(
    feature = "tcp",
    feature = "udp",
    feature = "dns",
    feature = "http",
    feature = "ws",
    feature = "mqtt",
    feature = "hls",
))]
use std::time::Duration;
#[cfg(any(
    feature = "tcp",
    feature = "udp",
    feature = "dns",
    feature = "http",
    feature = "ws",
    feature = "mqtt",
    feature = "hls",
))]
use tokio::time::timeout;

/// Wrap an async operation in a deadline. tokio sockets don't expose
/// per-read / per-write timeouts; we apply a single overall timeout
/// instead, which fits the "ping" use case where total time is short
/// and any individual op stalling means the whole ping has stalled.
#[cfg(any(
    feature = "tcp",
    feature = "udp",
    feature = "dns",
    feature = "http",
    feature = "ws",
    feature = "mqtt",
    feature = "hls",
))]
pub(crate) async fn with_timeout<F>(d: Duration, fut: F) -> Result<()>
where
    F: std::future::Future<Output = Result<()>>,
{
    match timeout(d, fut).await {
        Ok(inner) => inner,
        Err(_) => Err(io::Error::new(
            io::ErrorKind::TimedOut,
            "operation timed out",
        )),
    }
}