Struct PubSocket 

pub struct PubSocket<T: Transport<A>, A: Address> { /* private fields */ }

A publisher socket. This is thread-safe and can be cloned.

Publisher sockets are used to publish messages under certain topics to multiple subscribers.

Session

Per subscriber, the socket maintains a session. The session manages the underlying connection and all of its state, such as the topic subscriptions. It also manages a queue of messages to be transmitted on the connection.

Implementations

impl<T> PubSocket<T, SocketAddr>

where T: Transport<SocketAddr>,

pub async fn bind(&mut self, addr: impl ToSocketAddrs) -> Result<(), PubError>

Binds the socket to the given socket address.

This method is only available for transports that support SocketAddr as address type, like Tcp and Quic.

impl<T> PubSocket<T, PathBuf>

where T: Transport<PathBuf>,

pub async fn bind(&mut self, path: impl Into<PathBuf>) -> Result<(), PubError>

Binds the socket to the given path.

This method is only available for transports that support PathBuf as address type, like Ipc.

impl<T, A> PubSocket<T, A>

where T: Transport<A>, A: Address,

pub fn new(transport: T) -> Self

Creates a new reply socket with the default PubOptions.

pub fn with_options(transport: T, options: PubOptions) -> Self

Creates a new publisher socket with the given transport and options.

pub fn with_compressor<C: Compressor + 'static>(self, compressor: C) -> Self

Sets the message compressor for this socket.

pub fn with_connection_hook<H>(self, hook: H) -> Self

where H: ConnectionHook<T::Io>,

Sets the connection hook for this socket.

The connection hook is called when a new connection is accepted, before the connection is used for pub/sub communication.

Panics

Panics if the socket has already been bound (driver started).

pub async fn try_bind(&mut self, addresses: Vec<A>) -> Result<(), PubError>

Binds the socket to the given addresses in order until one succeeds.

This also spawns the socket driver task.

pub async fn publish( &self, topic: impl Into<String>, message: Bytes, ) -> Result<(), PubError>

Publishes a message to the given topic. If the topic doesn’t exist, this is a no-op.

pub fn try_publish(&self, topic: String, message: Bytes) -> Result<(), PubError>

Publishes a message to the given topic, compressing the payload if a compressor is set. If the topic doesn’t exist, this is a no-op.

pub fn stats(&self) -> &PubStats

pub fn local_addr(&self) -> Option<&A>

Returns the local address this socket is bound to. None if the socket is not bound.

Trait Implementations

impl<T: Clone + Transport<A>, A: Clone + Address> Clone for PubSocket<T, A>

where T::Io: Clone,

fn clone(&self) -> PubSocket<T, A>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.