Struct CtxHandle

pub struct CtxHandle { /* private fields */ }

A non-owning pointer to a Ctx.

A CtxHandle allows thread-safe configuration of the context aliased by the handle. It is also used to created sockets associated with the context.

Once the Ctx it is pointing to is shutdown or dropped, all associated CtxHandle will be invalidated. All calls involving an invalidated CtxHandle will return a InvalidCtx error.

use libzmq::{Ctx, Dish, ErrorKind};

// We create a `CtxHandle` from a new context. Since we drop
// the context pointed by the handle, it will no longer be valid
// once it reaches the outer scope.
let handle = {
    let ctx = Ctx::new();
    ctx.handle()
};

// Attempting to use the invalided handle will result in `InvalidCtx`
// errors.
let err = Dish::with_ctx(handle).unwrap_err();
match err.kind() {
    ErrorKind::InvalidCtx => (),
    _ => unreachable!(),
}

Implementations

impl CtxHandle

pub fn io_threads(self) -> i32

pub fn set_io_threads(self, nb_threads: i32) -> Result<(), Error>

pub fn max_sockets(self) -> i32

pub fn set_max_sockets(self, max: i32) -> Result<(), Error>

pub fn shutdown(self)

Trait Implementations

impl Clone for CtxHandle

fn clone(&self) -> CtxHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CtxHandle

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

Formats the value using the given formatter.

impl PartialEq for CtxHandle

fn eq(&self, other: &CtxHandle) -> 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 Copy for CtxHandle

impl Eq for CtxHandle

impl StructuralPartialEq for CtxHandle