Struct PublicationConfig 

pub struct PublicationConfig {
    pub group: IpAddr,
    pub dst_port: u16,
    pub outgoing_interface: Option<OutgoingInterface>,
    pub source_port: Option<u16>,
    pub source_addr: Option<IpAddr>,
    pub ttl: u32,
    pub loopback: bool,
}

Configuration for one multicast publication socket.

Fields

group: IpAddr

The destination multicast group.

dst_port: u16

The destination UDP port.

outgoing_interface: Option<OutgoingInterface>

The explicit multicast egress interface, if set.

source_port: Option<u16>

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

source_addr: Option<IpAddr>

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

ttl: u32

The multicast TTL (IPv4) or hop limit (IPv6) for transmitted packets.

loopback: bool

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

Implementations

impl PublicationConfig

pub fn new(group: impl Into<IpAddr>, port: u16) -> Self

Creates a basic multicast publication configuration.

pub fn family(&self) -> PublicationAddressFamily

Returns the address family for this publication.

pub fn is_ipv4(&self) -> bool

Returns true when the publication targets an IPv4 group.

pub fn is_ipv6(&self) -> bool

Returns true when the publication targets an IPv6 group.

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

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

pub fn with_outgoing_interface( self, outgoing_interface: impl Into<OutgoingInterface>, ) -> Self

Sets the multicast egress interface.

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

Sets the multicast egress interface using the existing IPv4-oriented convenience builder.

pub fn with_ipv6_interface_index(self, interface_index: u32) -> Self

Sets the IPv6 multicast egress interface by interface index.

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

Sets the source UDP port.

pub fn with_source_addr(self, source_addr: impl Into<IpAddr>) -> Self

Sets the exact local source address to bind before sending.

pub fn with_bind_addr(self, bind_addr: impl Into<SocketAddr>) -> Self

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

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

Sets the multicast TTL (IPv4) or hop limit (IPv6).

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

Enables or disables multicast loopback.

pub fn ipv6_scope(&self) -> Option<Ipv6MulticastScope>

Returns the multicast scope for the configured IPv6 group, if applicable.

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