Struct libzmq::Scatter

pub struct Scatter { /* fields omitted */ }

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_high_water_mark(1)
    .recv_timeout(Duration::from_millis(100))
    .build()?;

let worker_b = GatherBuilder::new()
    .connect(&addr)
    .recv_high_water_mark(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());

Methods

impl Scatter

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

Create a Scatter socket from the global context

Returned Error Variants

• CtxTerminated
• SocketLimit

pub fn with_ctx<C>(ctx: C) -> Result<Self, Error> where
    C: Into<Ctx>, 

Create a Scatter socket from a specific context.

Returned Error Variants

• CtxTerminated
• SocketLimit

pub fn ctx(&self) -> &Ctx

Returns a reference to the context of the socket.

Trait Implementations

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_high_water_mark(&self) -> Result<Quantity, Error>

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

fn set_send_high_water_mark<Q>(&self, qty: Q) -> Result<(), Error> where
    Q: Into<Quantity>, 

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<I, E>(&self, endpoints: I) -> Result<(), Error<usize>> where
    I: IntoIterator<Item = E>,
    E: Into<Endpoint>, 

Schedules a connection to one or more [Endpoints] and then accepts incoming connections.

fn bind<I, E>(&self, endpoints: I) -> Result<(), Error<usize>> where
    I: IntoIterator<Item = E>,
    E: Into<Endpoint>, 

Schedules a bind to one or more [Endpoints] and then accepts incoming connections.

fn disconnect<I, E>(&self, endpoints: I) -> Result<(), Error<usize>> where
    I: IntoIterator<Item = E>,
    E: Into<Endpoint>, 

Disconnect the socket from one or more [Endpoints].

fn last_endpoint(&self) -> Result<Option<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]. # Example ``` # use failure::Error; # # fn main() -> Result<(), Error> { use libzmq::{prelude::, Client, auth::};

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

Returns a the socket's heartbeat configuration.

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

Set the socket's heartbeat configuration.

impl Sync for Scatter

impl Eq for Scatter

impl Send for Scatter

impl PartialEq<Scatter> for Scatter

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

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<'a> From<&'a Scatter> for Pollable<'a>

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

Performs the conversion.

impl Debug for Scatter

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

Formats the value using the given formatter.