Skip to main content

IpcBroadcast

Struct IpcBroadcast 

Source
pub struct IpcBroadcast { /* private fields */ }
Expand description

A Unix-socket broadcast server. Drops slow clients; optionally replays the last buffer on connect; optionally decodes inbound length-prefixed frames.

Implementations§

Source§

impl IpcBroadcast

Source

pub async fn bind( path: impl AsRef<Path>, queue_depth: usize, keep_last: bool, inbound: Option<usize>, ) -> Result<(Self, Option<Receiver<InboundCommand>>)>

Bind the socket and start accepting clients.

  • queue_depth: per-client outbound queue size (256 for MAVLink, 32 for state, per the contracts).
  • keep_last: replay the last broadcast buffer to a newly connected client (state socket behaviour).
  • inbound: if Some, each client connection is also read as a stream of length-prefixed frames whose payloads are forwarded on the channel as InboundCommands carrying the writing connection’s identity (MAVLink command path). The capacity bounds the inbound backlog.
Source

pub async fn broadcast(&self, buf: Bytes)

Broadcast a byte buffer to all connected clients. Clients whose queue is full are dropped. If keep_last is set, the buffer is also stored as the last-state replayed to future clients.

Takes Bytes rather than Vec<u8> because every clone below — one per attached client, plus one for the retained last-state — used to be a full copy of the buffer. On the FC frame lane that is ~66 copies/s per connected consumer, growing with the number of consumers; as Bytes each is a refcount bump and the cost stops scaling with the client count. A producer holding a freshly built Vec<u8> converts with .into(), which is a move, not a copy.

Source

pub async fn client_count(&self) -> usize

Number of currently connected clients.

Source

pub fn queue_depth(&self) -> usize

The per-client queue depth this server was bound with.

Source

pub fn dropped_clients(&self) -> u64

Monotonic count of clients evicted for falling behind — a full outbound queue — since this server was bound. A client that disconnected cleanly is not counted here.

A slow consumer is pruned without an error reaching it, so this counter is the producer-visible signal that an eviction happened. The owning service folds it into the state snapshot it already publishes so the eviction is observable remotely rather than silent. Lock-free.

Trait Implementations§

Source§

impl Drop for IpcBroadcast

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more