soft3/radio/quinn/quinn-proto/src/address_discovery.rs

rust
ฯ€ 0.0% 478 words ยท 3 min 
//! Address discovery types from
//! <https://datatracker.ietf.org/doc/draft-seemann-quic-address-discovery/>

use crate::VarInt;

/// The role of each participant.
///
/// When enabled, this is reported as a transport parameter.
#[derive(PartialEq, Eq, Clone, Copy, Debug, Default)]
pub(crate) enum Role {
    /// Is able to report observer addresses to other peers, but it's not interested in receiving
    /// reports about its own address.
    SendOnly,
    /// Is interested on reports about its own observed address, but will not report back to other
    /// peers.
    ReceiveOnly,
    /// Will both report and receive reports of observed addresses.
    Both,
    /// Address discovery is disabled.
    #[default]
    Disabled,
}

impl TryFrom<VarInt> for Role {
    type Error = crate::transport_parameters::Error;

    fn try_from(value: VarInt) -> Result<Self, Self::Error> {
        match value.0 {
            0 => Ok(Self::SendOnly),
            1 => Ok(Self::ReceiveOnly),
            2 => Ok(Self::Both),
            _ => Err(crate::transport_parameters::Error::IllegalValue),
        }
    }
}

impl Role {
    /// Whether address discovery is disabled.
    pub(crate) fn is_disabled(&self) -> bool {
        matches!(self, Self::Disabled)
    }

    /// Whether this peer's role allows for address reporting to other peers.
    fn is_reporter(&self) -> bool {
        matches!(self, Self::SendOnly | Self::Both)
    }

    /// Whether this peer's role accepts observed address reports.
    fn receives_reports(&self) -> bool {
        matches!(self, Self::ReceiveOnly | Self::Both)
    }

    /// Whether this peer should report observed addresses to the other peer.
    pub(crate) fn should_report(&self, other: &Self) -> bool {
        self.is_reporter() && other.receives_reports()
    }

    /// Sets whether this peer should provide observed addresses to other peers.
    pub(crate) fn send_reports_to_peers(&mut self, provide: bool) {
        if provide {
            self.enable_sending_reports_to_peers()
        } else {
            self.disable_sending_reports_to_peers()
        }
    }

    /// Enables sending reports of observed addresses to other peers.
    fn enable_sending_reports_to_peers(&mut self) {
        match self {
            Self::SendOnly => {} // already enabled
            Self::ReceiveOnly => *self = Self::Both,
            Self::Both => {} // already enabled
            Self::Disabled => *self = Self::SendOnly,
        }
    }

    /// Disables sending reports of observed addresses to other peers.
    fn disable_sending_reports_to_peers(&mut self) {
        match self {
            Self::SendOnly => *self = Self::Disabled,
            Self::ReceiveOnly => {} // already disabled
            Self::Both => *self = Self::ReceiveOnly,
            Self::Disabled => {} // already disabled
        }
    }

    /// Sets whether this peer should accept received reports of observed addresses from other
    /// peers.
    pub(crate) fn receive_reports_from_peers(&mut self, receive: bool) {
        if receive {
            self.enable_receiving_reports_from_peers()
        } else {
            self.disable_receiving_reports_from_peers()
        }
    }

    /// Enables receiving reports of observed addresses from other peers.
    fn enable_receiving_reports_from_peers(&mut self) {
        match self {
            Self::SendOnly => *self = Self::Both,
            Self::ReceiveOnly => {} // already enabled
            Self::Both => {}        // already enabled
            Self::Disabled => *self = Self::ReceiveOnly,
        }
    }

    /// Disables receiving reports of observed addresses from other peers.
    fn disable_receiving_reports_from_peers(&mut self) {
        match self {
            Self::SendOnly => {} // already disabled
            Self::ReceiveOnly => *self = Self::Disabled,
            Self::Both => *self = Self::SendOnly,
            Self::Disabled => {} // already disabled
        }
    }

    /// Gives the [`VarInt`] representing this [`Role`] as a transport parameter.
    pub(crate) fn as_transport_parameter(&self) -> Option<VarInt> {
        match self {
            Self::SendOnly => Some(VarInt(0)),
            Self::ReceiveOnly => Some(VarInt(1)),
            Self::Both => Some(VarInt(2)),
            Self::Disabled => None,
        }
    }
}

Graph