Struct nng::Context

pub struct Context { /* fields omitted */ }

A socket context.

The context allows for independent and concurrent use of stateful operations on a single socket. Using contexts is an excellent way to write simpler concurrent applications, while retaining the benefits of the protocol-specific advanced processing.

Note that not all protocols allow for the creation of contexts.

Examples

See the documentation of the Aio type for examples on how to use Socket Contexts.

Methods

impl Context

pub fn new(socket: &Socket) -> Result<Context>

Creates a new socket context.

pub fn send<M: Into<Message>>(
    &self,
    aio: &Aio,
    msg: M
) -> Result<(), (Message, Error)>

Send a message using the context asynchronously.

This function will return immediately. If there is already an I/O operation in progress, this function will return ErrorKind::TryAgain and return the message to the caller.

pub fn recv(&self, aio: &Aio) -> Result<()>

Receive a message using the context asynchronously.

This function will return immediately. If there is already an I/O operation in progress that is not a receive operation, this function will return ErrorKind::TryAgain.

pub fn close(&self)

Closes the context.

Messages that have been submitted for sending may be flushed or delivered, depending on the underlying transport and the linger option. Further attempts to use the context (with this or any other handle) will result in an error. Threads waiting for operations on the context when this call is executed may also return with an error.

Closing the owning socket also closes this context. Additionally, the context is closed once all handles have been dropped.

Trait Implementations

impl GetOpt<ResendTime> for Context

impl GetOpt<SurveyTime> for Context

impl SetOpt<ResendTime> for Context

impl SetOpt<SurveyTime> for Context

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Context

impl Ord for Context

fn cmp(&self, other: &Context) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Context> for Context

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

fn partial_cmp(&self, other: &Context) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Context

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

Formats the value using the given formatter.

impl Hash for Context

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].