Skip to main content

PubSocket

Struct PubSocket 

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

A PUB socket for broadcasting messages to multiple subscribers.

PubSocket uses a worker pool architecture to handle multiple subscribers efficiently:

  • Multiple OS threads (default: CPU core count)
  • Each worker runs its own compio runtime with io_uring
  • Round-robin subscriber distribution across workers
  • Zero-copy message broadcasting via Arc<Bytes>
  • Lock-free subscription management

§Example

use monocoque::zmq::PubSocket;
use bytes::Bytes;

let mut socket = PubSocket::bind("127.0.0.1:5555").await?;

// Accept subscribers (non-blocking with worker pool)
socket.accept_subscriber().await?;

// Broadcast to all subscribers
socket.send(vec![Bytes::from("topic"), Bytes::from("data")]).await?;

Implementations§

Source§

impl PubSocket

Source

pub async fn bind(addr: impl ToSocketAddrs) -> Result<Self>

Bind to an address with default worker count (CPU cores).

Source

pub async fn bind_with_workers( addr: impl ToSocketAddrs, worker_count: usize, ) -> Result<Self>

Bind with a specific number of worker threads.

Source

pub async fn accept_subscriber(&mut self) -> Result<u64>

Accept a new subscriber connection.

Performs ZMTP handshake and assigns the subscriber to a worker thread. Returns the subscriber ID.

Source

pub async fn send(&mut self, msg: Vec<Bytes>) -> Result<()>

Broadcast a multipart message to all matching subscribers.

Messages are distributed to all workers in parallel. The first frame is typically used as a topic for subscription filtering.

Source

pub async fn send_frames(&mut self, frames: &[Bytes]) -> Result<()>

Broadcast a message given as borrowed frames.

Allocation-light counterpart to send: the shared message is allocated only when it matches a subscription, so publishing from a stack array (send_frames(&[topic, payload])) pays no per-message heap allocation on the common drop path of a topic-filtered stream.

Source

pub const fn subscriber_count(&self) -> usize

Get the number of active subscribers.

Source

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

Get the local address this socket is bound to.

Source

pub const fn socket_type() -> SocketType

Get the socket type.

§ZeroMQ Compatibility

Corresponds to ZMQ_TYPE (16) option.

Source

pub fn monitor(&mut self) -> SocketMonitor

Enable monitoring for this socket.

Returns a receiver for socket lifecycle events.

Source

pub fn options_mut(&mut self) -> &mut SocketOptions

Get a mutable reference to this socket’s options.

Source

pub fn drop_count(&self) -> u64

Number of messages dropped due to HWM backpressure.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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