mctx-core 0.2.1

Runtime-agnostic and portable IPv4 and IPv6 multicast sender library.
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
104
105
106
107
108
109
110

use std::{io, net::IpAddr};
use thiserror::Error;

/// Errors returned by the multicast sender core.
#[derive(Debug, Error)]
pub enum MctxError {
    /// The configured destination port is invalid.
    #[error("MCTX: invalid destination port")]
    InvalidDestinationPort,

    /// The configured group address is not a valid multicast IP address.
    #[error("MCTX: group must be a multicast IPv4 or IPv6 address")]
    InvalidMulticastGroup,

    /// The configured source port is invalid.
    #[error("MCTX: invalid source port")]
    InvalidSourcePort,

    /// The configured source IP address is invalid.
    #[error("MCTX: invalid source address")]
    InvalidSourceAddress,

    /// The configured multicast interface selector is invalid.
    #[error("MCTX: invalid interface address")]
    InvalidInterfaceAddress,

    /// The configured IPv6 interface index is invalid.
    #[error("MCTX: invalid IPv6 interface index")]
    InvalidIpv6InterfaceIndex,

    /// The configured source address does not match the group address family.
    #[error("MCTX: source address family must match multicast group family")]
    SourceAddressFamilyMismatch,

    /// The configured outgoing interface does not match the group address family.
    #[error("MCTX: outgoing interface family must match multicast group family")]
    OutgoingInterfaceFamilyMismatch,

    /// The configured IPv6 source address and outgoing interface disagree about
    /// which interface should be used.
    #[error(
        "MCTX: IPv6 source address {source_addr} resolves to interface index {source_interface_index}, expected {outgoing_interface_index}"
    )]
    Ipv6SourceInterfaceMismatch {
        source_addr: IpAddr,
        source_interface_index: u32,
        outgoing_interface_index: u32,
    },

    /// A scoped IPv6 multicast destination needs a concrete interface index.
    #[error(
        "MCTX: IPv6 interface-local and link-local multicast destinations require an outgoing interface or source address"
    )]
    Ipv6ScopedMulticastRequiresInterface,

    /// Resolving a local IPv6 address to its interface index failed.
    #[error("MCTX: failed to resolve IPv6 interface: {0}")]
    InterfaceDiscoveryFailed(String),

    /// A publication with the same configuration already exists.
    #[error("MCTX: publication already exists")]
    DuplicatePublication,

    /// No publication with the requested ID exists.
    #[error("MCTX: publication not found")]
    PublicationNotFound,

    /// Creating the UDP socket failed.
    #[error("MCTX: failed to create UDP socket: {0}")]
    SocketCreateFailed(io::Error),

    /// Setting a socket option failed.
    #[error("MCTX: failed to set socket option: {0}")]
    SocketOptionFailed(io::Error),

    /// Binding the UDP socket failed.
    #[error("MCTX: failed to bind UDP socket: {0}")]
    SocketBindFailed(io::Error),

    /// Connecting the UDP socket failed.
    #[error("MCTX: failed to connect UDP socket: {0}")]
    SocketConnectFailed(io::Error),

    /// Reading the local address from a socket failed.
    #[error("MCTX: failed to read local address from socket: {0}")]
    SocketLocalAddrFailed(io::Error),

    /// The provided existing socket does not match the configured IP family.
    #[error("MCTX: existing socket address family does not match the publication")]
    ExistingSocketAddressFamilyMismatch,

    /// The provided existing socket is bound to a different UDP port than requested.
    #[error("MCTX: existing socket is bound to UDP port {actual}, expected {expected}")]
    ExistingSocketPortMismatch { expected: u16, actual: u16 },

    /// The provided existing socket is bound to a different local IP address than requested.
    #[error("MCTX: existing socket is bound to local IP address {actual}, expected {expected}")]
    ExistingSocketAddressMismatch { expected: IpAddr, actual: IpAddr },

    /// Sending a packet failed.
    #[error("MCTX: send failed: {0}")]
    SendFailed(io::Error),
}

impl MctxError {
    #[cfg(feature = "tokio")]
    pub(crate) fn is_would_block(&self) -> bool {
        matches!(self, Self::SendFailed(error) if error.kind() == io::ErrorKind::WouldBlock)
    }
}