rings-core 0.20.0

Chord DHT implementation with ICE
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

use super::Error;

impl Error {
    pub(crate) fn unexpected_peer_ring_action(action: crate::dht::PeerRingAction) -> Self {
        Self::PeerRingUnexpectedAction(Box::new(action))
    }

    /// True when local pre-send admission or memory capacity is exhausted.
    ///
    /// These failures happen before backend acceptance, so retrying cannot
    /// duplicate a send. Post-acceptance timeouts are deliberately excluded:
    /// their remote outcome is ambiguous even after the connection is retired.
    pub(crate) const fn is_local_send_backpressure(&self) -> bool {
        matches!(
            self,
            Self::DataChannelSendQueueTimeout { .. }
                | Self::OutboundTransferCapacityExceeded { .. }
                | Self::OutboundTransferMemoryCapacityExceeded { .. }
                | Self::OutboundTransferAdmissionTimeout { .. }
                | Self::OutboundFirstFrameAdmissionTimeout { .. }
        )
    }

    /// Whether a data-plane send should be retried from freshly computed topology.
    pub(crate) const fn is_deferrable_data_plane_send(&self) -> bool {
        self.is_local_send_backpressure()
            || matches!(
                self,
                Self::ConnectionAttemptSuperseded { .. }
                    | Self::RTCDataChannelStateNotOpen
                    | Self::TransportNotReady { .. }
                    | Self::SwarmMissDidInTable(_)
                    | Self::Transport(rings_transport::error::Error::SendPermitRevoked)
            )
    }

    /// Whether this error should degrade peer quality through `FailedToSend`.
    pub(crate) const fn records_peer_send_failure(&self) -> bool {
        if self.is_local_send_backpressure() {
            return false;
        }

        match self {
            Self::ConnectionAttemptSuperseded { .. }
            | Self::OutboundSchedulerRuntimeUnavailable
            | Self::CancelledDetachedAdmissionPublishedSuccess
            | Self::DetachedPayloadCleanupTimeout { .. }
            | Self::DataChannelSendCompletionTimeout { .. }
            | Self::DataChannelDeliveryTimeout { .. }
            | Self::TrackedPayloadCleanupTimeout { .. } => false,
            Self::Transport(rings_transport::error::Error::SendPermitRevoked) => false,
            Self::TransportNotReady { state, .. } => matches!(
                state,
                rings_transport::core::transport::WebrtcConnectionState::Failed
                    | rings_transport::core::transport::WebrtcConnectionState::Closed
            ),
            _ => true,
        }
    }
}