rtc 0.9.0

Sans-I/O WebRTC implementation in Rust
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Transport statistics.
//!
//! This module contains the [`RTCTransportStats`] type which provides
//! information about the underlying transport (ICE, DTLS, SRTP).

use super::RTCStats;
use crate::peer_connection::transport::{
    RTCDtlsRole, RTCDtlsTransportState, RTCIceRole, RTCIceTransportState,
};
use serde::{Deserialize, Serialize};

/// Statistics for the transport layer.
///
/// This struct corresponds to the `RTCTransportStats` dictionary in the
/// W3C WebRTC Statistics API. It provides information about the underlying
/// transport, including ICE connectivity, DTLS security, and packet counters.
///
/// # W3C Reference
///
/// See [RTCTransportStats](https://www.w3.org/TR/webrtc-stats/#transportstats-dict*)
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RTCTransportStats {
    /// Base statistics fields (timestamp, type, id).
    #[serde(flatten)]
    pub stats: RTCStats,

    /// Total number of packets sent over this transport.
    pub packets_sent: u64,

    /// Total number of packets received over this transport.
    pub packets_received: u64,

    /// Total number of bytes sent over this transport.
    ///
    /// This includes all protocol overhead (STUN, DTLS, SRTP headers).
    pub bytes_sent: u64,

    /// Total number of bytes received over this transport.
    ///
    /// This includes all protocol overhead (STUN, DTLS, SRTP headers).
    pub bytes_received: u64,

    /// The ICE role of this peer.
    ///
    /// Either "controlling" or "controlled".
    pub ice_role: RTCIceRole,

    /// The local ICE username fragment.
    ///
    /// Used to identify this peer in ICE connectivity checks.
    pub ice_local_username_fragment: String,

    /// The current state of the ICE transport.
    pub ice_state: RTCIceTransportState,

    /// The current state of the DTLS transport.
    pub dtls_state: RTCDtlsTransportState,

    /// The DTLS role of this peer.
    ///
    /// Either "client" or "server".
    pub dtls_role: RTCDtlsRole,

    /// The negotiated TLS version.
    ///
    /// Typically "DTLS 1.2" for WebRTC.
    pub tls_version: String,

    /// The negotiated DTLS cipher suite.
    ///
    /// For example: "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256".
    pub dtls_cipher: String,

    /// The negotiated SRTP cipher suite.
    ///
    /// For example: "AES_CM_128_HMAC_SHA1_80".
    pub srtp_cipher: String,

    /// The ID of the selected ICE candidate pair.
    ///
    /// References an [`RTCIceCandidatePairStats`](super::ice_candidate_pair::RTCIceCandidatePairStats) object.
    pub selected_candidate_pair_id: String,

    /// Number of times the selected candidate pair has changed.
    pub selected_candidate_pair_changes: u32,

    /// The ID of the local certificate stats.
    ///
    /// References an [`RTCCertificateStats`](super::certificate::RTCCertificateStats) object.
    pub local_certificate_id: String,

    /// The ID of the remote certificate stats.
    ///
    /// References an [`RTCCertificateStats`](super::certificate::RTCCertificateStats) object.
    pub remote_certificate_id: String,

    /// Number of RTCP congestion control feedback messages sent.
    pub ccfb_messages_sent: u32,

    /// Number of RTCP congestion control feedback messages received.
    pub ccfb_messages_received: u32,
}