Struct zenoh_protocol::proto::Join

pub struct Join {
    pub version: u8,
    pub whatami: WhatAmI,
    pub zid: ZenohId,
    pub lease: Duration,
    pub sn_resolution: ZInt,
    pub next_sns: ConduitSnList,
}

Join message

NOTE: 16 bits (2 bytes) may be prepended to the serialized message indicating the total length
      in bytes of the message, resulting in the maximum length of a message being 65_535 bytes.
      This is necessary in those stream-oriented transports (e.g., TCP) that do not preserve
      the boundary of the serialized messages. The length is encoded as little-endian.
      In any case, the length of a message must not exceed 65_535 bytes.

The JOIN message is sent on a multicast Locator to advertise the transport parameters.

 7 6 5 4 3 2 1 0
+-+-+-+-+-+-+-+-+
|O|S|T|   JOIN  |
+-+-+-+-+-------+
~             |Q~ if O==1
+---------------+
| v_maj | v_min | -- Protocol Version VMaj.VMin
+-------+-------+
~    whatami    ~ -- Router, Peer or a combination of them
+---------------+
~    peer_id    ~ -- PID of the sender of the JOIN message
+---------------+
~     lease     ~ -- Lease period of the sender of the JOIN message(*)
+---------------+
~ sn_resolution ~ if S==1(*) -- Otherwise 2^28 is assumed(**)
+---------------+
~   [next_sn]   ~ (***)
+---------------+

- if Q==1 then the sender supports QoS.

(*)   if T==1 then the lease period is expressed in seconds, otherwise in milliseconds
(**)  if S==0 then 2^28 is assumed.
(***) if Q==1 then 8 sequence numbers are present: one for each priority.
      if Q==0 then only one sequence number is present.

Fields

version: u8

whatami: WhatAmI

zid: ZenohId

lease: Duration

sn_resolution: ZInt

next_sns: ConduitSnList

Implementations

impl Join

pub fn is_qos(&self) -> bool

Examples found in repository

src/proto/msg.rs (line 1662)

    fn options(&self) -> ZInt {
        let mut options = 0;
        if self.is_qos() {
            options |= tmsg::join_options::QOS;
        }
        options
    }

Trait Implementations

impl Clone for Join

fn clone(&self) -> Join

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Join

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

Formats the value using the given formatter.

impl Header for Join

fn header(&self) -> u8

impl Options for Join

fn options(&self) -> ZInt

fn has_options(&self) -> bool

impl PartialEq<Join> for Join

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Join

impl StructuralEq for Join

impl StructuralPartialEq for Join