Enum internet2::transport::zmqsocket::ZmqType

#[repr(u8)]
#[non_exhaustive]pub enum ZmqType {
    Pull,
    Push,
    Req,
    Rep,
    Pub,
    Sub,
    RouterBind,
    RouterConnect,
}

API type for node-to-node communications used by ZeroMQ

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pull

Pure peer-to-peer communications done with PUSH/PULL pair of ZMQ sockets. Each node can send unordered set of messages and does not wait for a response. This part represents listening socket (zmq::SocketType::PULL)

Push

Pure peer-to-peer communications done with PUSH/PULL pair of ZMQ sockets. Each node can send unordered set of messages and does not wait for a response. This part represents connected socket (zmq::SocketType::PUSH)

Req

Remote procedure call communications done with REQ/REP pair of ZMQ sockets. Two roles: client and server; client sends requests and awaits for client responses. This part represents client-size socket (zmq::SocketType::REQ)

Rep

Remote procedure call communications done with REQ/REP pair of ZMQ sockets. Two roles: client and server; client sends requests and awaits for client responses. This part represents client-size socket (zmq::SocketType::REP)

Pub

Subscription API done with SUB/PUB pair of ZMQ sockets. Two roles: publisher (server) and subscriber (client); subscriber awaits for messages from publisher and does not communicates back. This part represents publisher part (zmq::SocketType::PUB)

Sub

Subscription API done with SUB/PUB pair of ZMQ sockets. Two roles: publisher (server) and subscriber (client); subscriber awaits for messages from publisher and does not communicates back. This part represents subscriber part (zmq::SocketType::SUB)

RouterBind

Message bus: each message has a receiver and sender, and multiple peers may communicate directly with each other in asynchronous mode. Represents zmq::SocketType::ROUTER socket which is bind to

RouterConnect

Message bus: each message has a receiver and sender, and multiple peers may communicate directly with each other in asynchronous mode. Represents zmq::SocketType::ROUTER socket wich is connected to

Implementations

impl ZmqType

pub fn socket_type(&self) -> SocketType

Returns zmq::SocketType corresponding to the given [ApiType]

pub fn api_name(&self) -> String

Returns name for the used ZMQ API type that can be used as a part of URL query

Trait Implementations

impl Clone for ZmqType

pub fn clone(&self) -> ZmqType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ZmqType

impl Debug for ZmqType

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

Formats the value using the given formatter.

impl Display for ZmqType

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

Formats the value using the given formatter.

impl Eq for ZmqType

impl FromStr for ZmqType

type Err = UnknownApiType

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ZmqType

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ZmqType

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ZmqType> for ZmqType

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

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

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

This method tests for !=.

impl PartialOrd<ZmqType> for ZmqType

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

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

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

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for ZmqType

impl StructuralPartialEq for ZmqType