Struct MulticastSocket

Source

pub struct MulticastSocket { /* private fields */ }

Expand description

A builder for creating multicast UDP sockets suitable for mDNS.

MulticastSocket provides a convenient way to create properly configured UDP sockets for mDNS communication. The resulting socket will be:

Bound to the specified address (typically 0.0.0.0:5353)
Configured with SO_REUSEADDR enabled
Configured with SO_REUSEPORT enabled (on supported platforms)
Set to non-blocking mode for async compatibility
Joined to the mDNS multicast group (224.0.0.251)

§Examples

Basic usage with tokio:

use rtc_mdns::MulticastSocket;
use std::net::SocketAddr;

let bind_addr: SocketAddr = "0.0.0.0:5353".parse().unwrap();
let std_socket = MulticastSocket::new(bind_addr).into_std()?;
let socket = tokio::net::UdpSocket::from_std(std_socket)?;

With a specific network interface:

use rtc_mdns::MulticastSocket;
use std::net::{Ipv4Addr, SocketAddr};

let bind_addr: SocketAddr = "0.0.0.0:5353".parse().unwrap();
let interface = Ipv4Addr::new(192, 168, 1, 100);
let std_socket = MulticastSocket::new(bind_addr)
    .with_interface(interface)
    .into_std()?;

Implementations§

Source §

impl MulticastSocket

Source

pub fn new() -> Self

Creates a new MulticastSocket builder with the specified bind address.

§Arguments

bind_addr - The local address to bind to. Use 0.0.0.0:5353 to listen on all interfaces on the standard mDNS port.

§Example

use rtc_mdns::MulticastSocket;

let builder = MulticastSocket::new();

Source

pub fn with_multicast_local_ipv4(self, multicast_local_ipv4: Ipv4Addr) -> Self

Sets the local IPv4 address to bind the multicast socket to.

Defaults to unspecified (0.0.0.0), letting the OS choose.

Source

pub fn with_multicast_local_port(self, multicast_local_port: u16) -> Self

Sets the local port to bind the multicast socket to.

Defaults to the mDNS port (5353), which is required to receive multicast queries from other hosts; a different port is only useful for testing.

Source

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

Sets a specific network interface for multicast operations.

If not set, the socket joins the multicast group on all interfaces (INADDR_ANY).

§Arguments

interface - The IPv4 address of the network interface to use.

§Example

use rtc_mdns::MulticastSocket;
use std::net::Ipv4Addr;

let builder = MulticastSocket::new()
    .with_interface(Ipv4Addr::new(192, 168, 1, 100));

Source

pub fn into_std(self) -> Result<UdpSocket>

Converts this builder into a configured std::net::UdpSocket.

This method creates the socket with the following configuration:

SO_REUSEADDR enabled (allows multiple processes to bind)
SO_REUSEPORT enabled on Unix platforms (except Solaris/illumos)
Non-blocking mode enabled (for async compatibility)
Joined to the mDNS multicast group (224.0.0.251)

§Errors

Returns an error if:

Socket creation fails
Setting socket options fails
Binding to the address fails
Joining the multicast group fails

§Example

use rtc_mdns::MulticastSocket;
use std::net::SocketAddr;

let bind_addr: SocketAddr = "0.0.0.0:5353".parse().unwrap();
let std_socket = MulticastSocket::new(bind_addr).into_std()?;

// Use with tokio:
let socket = tokio::net::UdpSocket::from_std(std_socket)?;