Struct Scatter

pub struct Scatter { /* private fields */ }

A Scatter socket is used to pipeline messages to workers.

Messages are round-robined to all connected Gather sockets.

Summary of Characteristics

Characteristic	Value
Compatible peer sockets	Gather
Direction	Unidirectional
Send/receive pattern	Send only
Outgoing routing strategy	Round-robin
Incoming routing strategy	Fair-queued
Action in mute state	Block

Example

use libzmq::{prelude::*, *};
use std::time::Duration;

let addr = InprocAddr::new_unique();

// Our load balancing producer.
let lb = ScatterBuilder::new()
    .bind(&addr)
    .build()?;

let worker_a = GatherBuilder::new()
    .connect(&addr)
    .recv_hwm(1)
    .recv_timeout(Duration::from_millis(100))
    .build()?;

let worker_b = GatherBuilder::new()
    .connect(&addr)
    .recv_hwm(1)
    .recv_timeout(Duration::from_millis(100))
    .build()?;

// Send messages to workers in a round-robin fashion.
lb.send("")?;
lb.send("")?;

assert!(worker_a.recv_msg()?.is_empty());
assert!(worker_b.recv_msg()?.is_empty());

Implementations

impl Scatter

pub fn new() -> Result<Self, Error>

Create a Scatter socket from the global context

Returned Error Variants

• InvalidCtx
• SocketLimit

pub fn with_ctx(handle: CtxHandle) -> Result<Self, Error>

Create a Scatter socket associated with a specific context from a CtxHandle.

Returned Error Variants

• InvalidCtx
• SocketLimit

pub fn ctx(&self) -> CtxHandle

Returns a handle to the context of the socket.

Trait Implementations

impl Clone for Scatter

fn clone(&self) -> Scatter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scatter

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

Formats the value using the given formatter.

impl<'a> From<&'a Scatter> for Pollable<'a>

fn from(scatter: &'a Scatter) -> Self

Converts to this type from the input type.

impl Heartbeating for Scatter

fn heartbeat(&self) -> Option<Heartbeat>

Returns a the socket’s heartbeating configuration.

fn set_heartbeat(&self, maybe: Option<Heartbeat>) -> Result<(), Error>

Sets the socket’s heartbeating configuration.

impl PartialEq for Scatter

fn eq(&self, other: &Scatter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SendMsg for Scatter

fn send<M>(&self, msg: M) -> Result<(), Error<Msg>>

where M: Into<Msg>,

Push a message into the outgoing socket queue.

fn try_send<M>(&self, msg: M) -> Result<(), Error<Msg>>

where M: Into<Msg>,

Try to push a message into the outgoing socket queue without blocking.

fn send_hwm(&self) -> Result<i32, Error>

The high water mark for outbound messages on the specified socket.

fn set_send_hwm(&self, hwm: i32) -> Result<(), Error>

Set the high water mark for outbound messages on the specified socket.

fn send_timeout(&self) -> Result<Period, Error>

Sets the timeout for [send] on the socket.

fn set_send_timeout<P>(&self, period: P) -> Result<(), Error>

where P: Into<Period>,

Sets the timeout for [send] on the socket.

impl Socket for Scatter

fn connect<E>(&self, endpoint: E) -> Result<(), Error>

where E: Into<Endpoint>,

Schedules a connection to a Endpoint.

fn bind<E>(&self, endpoint: E) -> Result<(), Error>

where E: Into<Endpoint>,

Schedules a bind to a Endpoint and then accepts incoming connections.

fn disconnect<E>(&self, endpoint: E) -> Result<(), Error>

where E: Into<Endpoint>,

Disconnect the socket from a Endpoint.

fn unbind<I, E>(&self, endpoint: E) -> Result<(), Error>

where E: Into<Endpoint>,

Unbind the socket from a Endpoint.

fn last_endpoint(&self) -> Result<Endpoint, Error>

Retrieve the last endpoint connected or bound to.

fn mechanism(&self) -> Mechanism

Returns the socket’s Mechanism.

fn set_mechanism<M>(&self, mechanism: M) -> Result<(), Error>

where M: Into<Mechanism>,

Set the socket’s Mechanism.

impl Eq for Scatter

impl Send for Scatter

impl Sync for Scatter