mctx-core 0.3.0

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

use crate::error::MctxError;
use crate::raw_ip::platform::{RawIpTransmitSocket, open_raw_ip_socket, send_ip_datagram};
use crate::raw_ip::{RawIpSendReport, RawIpSocketConfig};

/// Stable identifier for one generic raw-IP publication.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct RawIpPublicationId(pub u64);

/// One ready-to-send generic raw-IP socket configuration.
#[derive(Debug)]
pub struct RawIpPublication {
    id: RawIpPublicationId,
    config: RawIpSocketConfig,
    socket: RawIpTransmitSocket,
}

impl RawIpPublication {
    /// Creates a ready-to-send raw-IP publication.
    pub fn new(id: RawIpPublicationId, config: RawIpSocketConfig) -> Result<Self, MctxError> {
        let socket = open_raw_ip_socket(&config)?;
        Ok(Self { id, config, socket })
    }

    /// Returns this publication's stable identifier.
    pub fn id(&self) -> RawIpPublicationId {
        self.id
    }

    /// Returns the immutable socket configuration.
    pub fn config(&self) -> &RawIpSocketConfig {
        &self.config
    }

    /// Sends a complete caller-provided IPv4 or IPv6 datagram.
    pub fn send_ip_datagram(&self, ip_datagram: &[u8]) -> Result<RawIpSendReport, MctxError> {
        send_ip_datagram(&self.socket, self.id, ip_datagram)
    }
}