Struct Publication 

pub struct Publication { /* private fields */ }

One ready-to-send multicast publication.

Implementations

impl Publication

pub fn new( id: PublicationId, config: PublicationConfig, ) -> Result<Self, MctxError>

Creates and configures a new multicast publication socket.

pub fn new_with_socket( id: PublicationId, config: PublicationConfig, socket: Socket, ) -> Result<Self, MctxError>

Wraps and configures an existing multicast socket.

pub fn new_with_udp_socket( id: PublicationId, config: PublicationConfig, socket: UdpSocket, ) -> Result<Self, MctxError>

Wraps and configures an existing standard-library UDP socket.

pub fn id(&self) -> PublicationId

Returns the publication ID.

pub fn config(&self) -> &PublicationConfig

Returns the configured publication parameters.

pub fn destination(&self) -> SocketAddr

Returns the resolved destination address.

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

Returns the resolved destination IPv4 address.

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

Returns the resolved destination IPv6 address.

pub fn socket(&self) -> &Socket

Returns a shared reference to the live socket.

Avoid rebinding or reconnecting the socket through this handle. The publication caches its resolved local address after the first lookup for send reporting, and shared-reference socket mutation cannot invalidate that cache.

pub fn socket_mut(&mut self) -> &mut Socket

Returns a mutable reference to the live socket.

This clears any cached local-address metadata before handing the socket out so the next send or local_addr() call refreshes it.

pub fn send(&self, payload: &[u8]) -> Result<SendReport, MctxError>

Sends one payload.

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

Returns the publication socket local address.

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

Returns the publication socket local IPv4 address.

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

Returns the publication socket local IPv6 address.

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

Returns the effective local source address.

pub fn announce_tuple(&self) -> Result<(IpAddr, IpAddr, u16), MctxError>

Returns the (source, group, udp_port) tuple needed for announce frames.

pub fn into_socket(self) -> Socket

Consumes the publication and returns the live socket.

pub fn into_parts(self) -> PublicationParts

Consumes the publication and returns all parts.

Trait Implementations

impl AsRawFd for Publication

Available on Unix only.

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for Publication

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

Formats the value using the given formatter.