Struct Context 

pub struct Context { /* private fields */ }

Small owner for a set of multicast publication sockets.

Implementations

impl Context

pub fn new() -> Self

Creates an empty multicast sender context.

pub fn publication_count(&self) -> usize

Returns the number of tracked publications.

pub fn contains_publication(&self, id: PublicationId) -> bool

Returns whether a publication ID exists in the context.

pub fn get_publication(&self, id: PublicationId) -> Option<&Publication>

Returns an immutable reference to one publication.

pub fn get_publication_mut( &mut self, id: PublicationId, ) -> Option<&mut Publication>

Returns a mutable reference to one publication.

pub fn add_publication( &mut self, config: PublicationConfig, ) -> Result<PublicationId, MctxError>

Creates a new publication socket from configuration and stores it.

pub fn add_publication_with_socket( &mut self, config: PublicationConfig, socket: Socket, ) -> Result<PublicationId, MctxError>

Stores an existing socket as a publication after configuring it.

pub fn add_publication_with_udp_socket( &mut self, config: PublicationConfig, socket: UdpSocket, ) -> Result<PublicationId, MctxError>

Stores an existing standard-library UDP socket as a publication after configuring it.

pub fn remove_publication(&mut self, id: PublicationId) -> bool

Removes one publication and drops its socket.

pub fn take_publication(&mut self, id: PublicationId) -> Option<Publication>

Extracts one publication from the context.

pub fn publications(&self) -> &[Publication]

Returns all tracked publications.

pub fn publications_mut(&mut self) -> &mut [Publication]

Returns all tracked publications mutably.

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

Sends one payload through the selected publication.

pub fn send_all( &self, payload: &[u8], out: &mut Vec<SendReport>, ) -> Result<usize, MctxError>

Sends the same payload through every publication and pushes reports into out.

If one publication fails, reports already written into out are preserved.

pub fn metrics_snapshot(&self) -> ContextMetricsSnapshot

Returns a snapshot of the context’s current metrics.

Counter fields such as total_packets_sent are cumulative for the lifetime of the context for send activity issued through Context methods. They are not recomputed from the currently active publications, and they do not decrease when a publication is removed.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.