Struct libzmq::Client

pub struct Client { /* fields omitted */ }

A Client socket is used for advanced request-reply messaging.

Client sockets are threadsafe and can be used from multiple threads at the same time. Note that replies from a Server socket will go to the first client thread that calls recv. If you need to get replies back to the originating thread, use one Client socket per thread.

When a Client socket is connected to multiple sockets, outgoing messages are distributed between connected peers on a round-robin basis. Likewise, the Client socket receives messages fairly from each connected peer.

Mute State

When Client socket enters the mute state due to having reached the high water mark, or if there are no peers at all, then any send operations on the socket shall block until the mute state ends or at least one peer becomes available for sending; messages are not discarded.

Summary of Characteristics

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

Example

use libzmq::{prelude::*, *};
use std::convert::TryInto;

// Use a system assigned port.
let addr: TcpAddr = "127.0.0.1:*".try_into()?;

let server = ServerBuilder::new()
    .bind(addr)
    .build()?;

// Retrieve the addr that was assigned.
let bound = server.last_endpoint()?;

let client = ClientBuilder::new()
    .connect(bound)
    .build()?;

// Send a string request.
client.send("tell me something")?;

// Receive the client request.
let msg = server.recv_msg()?;
let id = msg.routing_id().unwrap();

// Reply to the client.
let mut reply: Msg = "it takes 224 bits to store a i32 in java".into();
reply.set_routing_id(id);
server.send(reply)?;

// We can reply twice if we want.
let mut reply: Msg = "also don't talk to me".into();
reply.set_routing_id(id);
server.send(reply)?;

// Retreive the first reply.
let mut msg = client.recv_msg()?;
// And the second.
client.recv(&mut msg)?;

Methods

impl Client

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

Create a Client 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 Client 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 RecvMsg for Client

fn recv(&self, msg: &mut Msg) -> Result<(), Error>

Retreive a message from the inbound socket queue.

fn try_recv(&self, msg: &mut Msg) -> Result<(), Error>

Try to retrieve a message from the inbound socket queue without blocking.

fn recv_msg(&self) -> Result<Msg, Error>

A convenience function that allocates a [Msg] with the same properties as [recv].

fn try_recv_msg(&self) -> Result<Msg, Error>

A convenience function that allocates a [Msg] with the same properties as [try_recv].

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

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

fn set_recv_high_water_mark(&self, maybe: Option<i32>) -> Result<(), Error>

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

fn recv_timeout(&self) -> Result<Option<Duration>, Error>

The timeout for [recv] on the socket.

fn set_recv_timeout(&self, maybe: Option<Duration>) -> Result<(), Error>

Sets the timeout for [recv] on the socket.

impl SendMsg for Client

fn send<M>(&self, sendable: M) -> Result<(), Error<Msg>> where
    M: Into<Msg>, 

Push a message into the outgoing socket queue.

fn try_send<M>(&self, sendable: 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<Option<i32>, Error>

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

fn set_send_high_water_mark(&self, maybe: Option<i32>) -> Result<(), Error>

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

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

Sets the timeout for [send] on the socket.

fn set_send_timeout(&self, maybe: Option<Duration>) -> Result<(), Error>

Sets the timeout for [send] on the socket.

impl Socket for Client

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 connected(&self) -> Vec<Endpoint>

Returns a snapshot of the list of connected Endpoint.

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 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 bound(&self) -> Vec<Endpoint>

Returns a snapshot of the list of bound Endpoint.

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

Unbinds the socket from one or more [Endpoints].

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

Retrieve the last endpoint connected or bound to.

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

Retrieve the maximum length of the queue of outstanding peer connections.

fn set_backlog(&self, value: i32) -> Result<(), Error>

Set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports.

fn heartbeat_interval(&self) -> Result<Duration, Error>

The interval between sending ZMTP heartbeats.

fn set_heartbeat_interval(&self, duration: Duration) -> Result<(), Error>

Sets the interval between sending ZMTP PINGs (aka. heartbeats).

fn heartbeat_timeout(&self) -> Result<Duration, Error>

How long to wait before timing-out a connection after sending a PING ZMTP command and not receiving any traffic.

fn set_heartbeat_timeout(&self, duration: Duration) -> Result<(), Error>

How long to wait before timing-out a connection after sending a PING ZMTP command and not receiving any traffic.

fn heartbeat_ttl(&self) -> Result<Duration, Error>

The timeout on the remote peer for ZMTP heartbeats. If this option and heartbeat_interval is not None the remote side shall time out the connection if it does not receive any more traffic within the TTL period.

fn set_heartbeat_ttl(&self, duration: Duration) -> Result<(), Error>

Set timeout on the remote peer for ZMTP heartbeats. If this option and heartbeat_interval is not None the remote side shall time out the connection if it does not receive any more traffic within the TTL period.

fn linger(&self) -> Result<Option<Duration>, Error>

Returns the linger period for the socket shutdown.

fn set_linger(&self, maybe: Option<Duration>) -> Result<(), Error>

Sets the linger period for the socket shutdown.

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::{PlainClientCreds, Mechanism}};

impl Sync for Client

impl Send for Client

impl PartialEq<Client> for Client

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

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

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

This method tests for !=.

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Client

impl Debug for Client

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

Formats the value using the given formatter.