Struct zenoh_protocol::proto::Close

pub struct Close {
    pub pid: Option<PeerId>,
    pub reason: u8,
    pub link_only: bool,
}

Close 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 CLOSE message is sent in any of the following two cases:
    1) in response to an OPEN message which is not accepted;
    2) at any time to arbitrarly close the session with the corresponding peer.

 7 6 5 4 3 2 1 0
+-+-+-+-+-+-+-+-+
|X|K|I|  CLOSE  |
+-+-+-+-+-------+
~    peer_id    ~  if I==1 -- PID of the target peer.
+---------------+
|     reason    |
+---------------+

- if K==0 then close the whole zenoh session.
- if K==1 then close the transport link the CLOSE message was sent on (e.g., TCP socket) but
          keep the whole session open. NOTE: the session will be automatically closed when
          the session's lease period expires.

Fields

pid: Option<PeerId>

reason: u8

link_only: bool

Trait Implementations

impl Clone for Close

fn clone(&self) -> Close

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Close

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

Formats the value using the given formatter.

impl PartialEq<Close> for Close

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

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

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

This method tests for !=.

impl StructuralPartialEq for Close