Struct PublicationConfig 

pub struct PublicationConfig {
    pub group: Ipv4Addr,
    pub dst_port: u16,
    pub interface: Option<Ipv4Addr>,
    pub source_port: Option<u16>,
    pub source_addr: Option<Ipv4Addr>,
    pub ttl: u32,
    pub loopback: bool,
}

Configuration for one multicast publication socket.

Fields

group: Ipv4Addr

The destination multicast group.

dst_port: u16

The destination UDP port.

interface: Option<Ipv4Addr>

The local interface to use for multicast egress, if explicitly set.

source_port: Option<u16>

The source UDP port to bind before sending, if explicitly set.

source_addr: Option<Ipv4Addr>

The source IPv4 address to bind before sending, if explicitly set.

ttl: u32

The multicast TTL for transmitted packets.

loopback: bool

Whether outbound multicast packets should be looped back to the local host.

Implementations

impl PublicationConfig

pub fn new(group: Ipv4Addr, port: u16) -> Self

Creates a basic multicast publication configuration.

pub fn validate(&self) -> Result<(), MctxError>

Validates the configuration and returns an error if it is not usable.

pub fn with_interface(self, interface: Ipv4Addr) -> Self

Sets the multicast egress interface.

pub fn with_source_port(self, source_port: u16) -> Self

Sets the source UDP port.

pub fn with_source_addr(self, source_addr: Ipv4Addr) -> Self

Sets the exact local IPv4 source address to bind before sending.

pub fn with_bind_addr(self, bind_addr: SocketAddrV4) -> Self

Sets the exact local IPv4 address and UDP port to bind before sending.

pub fn with_ttl(self, ttl: u32) -> Self

Sets the multicast TTL.

pub fn with_loopback(self, loopback: bool) -> Self

Enables or disables multicast loopback.

pub fn destination(&self) -> SocketAddrV4

Returns the configured destination socket address.

pub fn bind_addr(&self) -> Option<SocketAddrV4>

Returns the exact local bind address requested by the configuration, if any.

Trait Implementations

impl Clone for PublicationConfig

fn clone(&self) -> PublicationConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PublicationConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for PublicationConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PublicationConfig

fn eq(&self, other: &PublicationConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PublicationConfig

impl StructuralPartialEq for PublicationConfig