Struct SubSocket 

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

A subscriber socket. This socket implements Stream and yields incoming PubMessages.

Implementations

impl<T> SubSocket<T, SocketAddr>

where T: Transport<SocketAddr> + Send + Sync + Unpin + 'static,

pub async fn connect( &mut self, endpoint: impl ToSocketAddrs, ) -> Result<(), SubError>

Connects to the given endpoint asynchronously.

pub fn try_connect( &mut self, endpoint: impl Into<String>, ) -> Result<(), SubError>

Attempts to connect to the given endpoint immediately.

pub async fn disconnect( &mut self, endpoint: impl ToSocketAddrs, ) -> Result<(), SubError>

Disconnects from the given endpoint asynchronously.

pub fn try_disconnect( &mut self, endpoint: impl Into<String>, ) -> Result<(), SubError>

Attempts to disconnect from the given endpoint immediately.

impl<T> SubSocket<T, PathBuf>

where T: Transport<PathBuf> + Send + Sync + Unpin + 'static,

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

Connects to the given path asynchronously.

pub fn try_connect_path( &mut self, path: impl Into<PathBuf>, ) -> Result<(), SubError>

Attempts to connect to the given path immediately.

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

Disconnects from the given path asynchronously.

pub fn try_disconnect_path( &mut self, path: impl Into<PathBuf>, ) -> Result<(), SubError>

Attempts to disconnect from the given path immediately.

impl<T, A> SubSocket<T, A>

where T: Transport<A> + Send + Sync + Unpin + 'static, A: Address,

pub fn new(transport: T) -> Self

Creates a new subscriber socket with the default SubOptions.

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

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

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 after connecting to each publisher, before the connection is used for pub/sub communication.

Panics

Panics if the driver has already been started (i.e., after calling connect).

pub async fn connect_inner(&mut self, endpoint: A) -> Result<(), SubError>

Asynchronously connects to the endpoint.

pub fn try_connect_inner(&mut self, endpoint: A) -> Result<(), SubError>

Immediately send a connect command to the driver.

pub async fn disconnect_inner(&mut self, endpoint: A) -> Result<(), SubError>

Asynchronously disconnects from the endpoint.

pub fn try_disconnect_inner(&mut self, endpoint: A) -> Result<(), SubError>

Immediately send a disconnect command to the driver.

pub async fn subscribe( &mut self, topic: impl Into<String>, ) -> Result<(), SubError>

Subscribes to the given topic. This will subscribe to all connected publishers. If the topic does not exist on a publisher, this will not return any data. Any publishers that are connected after this call will also be subscribed to.

pub fn try_subscribe( &mut self, topic: impl Into<String>, ) -> Result<(), SubError>

Immediately send a subscribe command to the driver.

pub async fn unsubscribe( &mut self, topic: impl Into<String>, ) -> Result<(), SubError>

Unsubscribe from the given topic. This will unsubscribe from all connected publishers.

pub fn try_unsubscribe( &mut self, topic: impl Into<String>, ) -> Result<(), SubError>

Immediately send an unsubscribe command to the driver.

pub fn stats(&self) -> &SubStats<A>

Returns the statistics specific to the subscriber socket.

Trait Implementations

impl<T: Transport<A>, A: Address> Drop for SubSocket<T, A>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Transport<A> + Unpin, A: Address> Stream for SubSocket<T, A>

type Item = PubMessage<A>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.