Struct SubscriptionConfig 

pub struct SubscriptionConfig {
    pub group: IpAddr,
    pub source: SourceFilter,
    pub dst_port: u16,
    pub interface: Option<IpAddr>,
    pub interface_index: Option<u32>,
}

Configuration for a multicast receive subscription.

This defines the multicast group, source filtering mode (ASM or SSM), destination port, and optionally the local interface to join on.

Fields

group: IpAddr

The destination multicast group to join.

source: SourceFilter

The source filtering mode for the subscription.

dst_port: u16

The destination UDP port to receive on.

interface: Option<IpAddr>

The local interface address to join on, if explicitly specified.

interface_index: Option<u32>

The local IPv6 interface index to join on, if explicitly specified.

This is primarily useful for scoped/link-local IPv6 multicast where an interface address alone may be ambiguous across multiple adapters.

Implementations

impl SubscriptionConfig

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

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

pub fn family(&self) -> SubscriptionAddressFamily

Returns the configured address family.

pub fn is_ipv4(&self) -> bool

Returns true when this is an IPv4 subscription.

pub fn is_ipv6(&self) -> bool

Returns true when this is an IPv6 subscription.

pub fn source_addr(&self) -> Option<IpAddr>

Returns the configured source address, if any.

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

Creates an ASM ((*, G)) subscription configuration.

pub fn asm_v6(group: Ipv6Addr, port: u16) -> Self

Creates an IPv6 ASM ((*, G)) subscription configuration.

pub fn asm_ip(group: IpAddr, port: u16) -> Self

Creates an ASM ((*, G)) subscription configuration from any IP family.

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

Creates an SSM ((S, G)) subscription configuration.

pub fn ssm_v6(group: Ipv6Addr, source: Ipv6Addr, port: u16) -> Self

Creates an IPv6 SSM ((S, G)) subscription configuration.

pub fn ssm_ip(group: IpAddr, source: IpAddr, port: u16) -> Self

Creates an SSM ((S, G)) subscription configuration from any IP family.

Trait Implementations

impl Clone for SubscriptionConfig

fn clone(&self) -> SubscriptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionConfig

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

Formats the value using the given formatter.

impl PartialEq for SubscriptionConfig

fn eq(&self, other: &SubscriptionConfig) -> 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 SubscriptionConfig

impl StructuralPartialEq for SubscriptionConfig