Struct Handshake 

pub struct Handshake { /* private fields */ }

Peer-handshake control payload exchanged on top of a DmsgType::GossipSyn frame.

Today the handshake carries the cluster-wide capability advertisement (see crate::cluster::capability). Future fields will be appended as new typed records; older peers ignore unknown trailing bytes.

Wire format

magic(4) = "DHS1"
flags(2) = 0
CapabilityAd (length-prefixed, see
               `CapabilityAd::encode` for the exact layout)

All multi-byte integers are little-endian. The encoding uses only the standard library; no external codec is pulled in.

Examples

use dynomite::cluster::capability::{CapabilityAd, CapabilityAdEntry};
use dynomite::proto::dnode::Handshake;
let ad = CapabilityAd::from_entries(vec![
    CapabilityAdEntry::new("framing".into(), vec![vec![1, 0, 0, 0]]),
]);
let hs = Handshake::new(ad.clone());
let bytes = hs.encode();
let back = Handshake::decode(&bytes).unwrap();
assert_eq!(back.capabilities(), &ad);

Implementations

impl Handshake

pub const MAGIC: [u8; 4]

Magic literal that opens every handshake payload.

pub fn new(capabilities: CapabilityAd) -> Self

Build a handshake carrying capabilities.

pub fn capabilities(&self) -> &CapabilityAd

Borrow the embedded capability advertisement.

pub fn into_capabilities(self) -> CapabilityAd

Consume the handshake and return the embedded advertisement.

pub fn encode(&self) -> Vec<u8>

Serialise the handshake to a length-prefixed byte stream.

pub fn decode(bytes: &[u8]) -> Result<Self, CapabilityCodecError>

Inverse of Handshake::encode. Surfaces a typed error when the magic / version is wrong or the embedded advertisement is malformed.

pub const fn header_len() -> usize

Number of bytes the handshake’s fixed-size prefix occupies before the embedded advertisement. Useful in tests that assert the on-the-wire delta.

Trait Implementations

impl Clone for Handshake

fn clone(&self) -> Handshake

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Handshake

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

Formats the value using the given formatter.

impl Default for Handshake

fn default() -> Handshake

Returns the “default value” for a type.

impl PartialEq for Handshake

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

impl StructuralPartialEq for Handshake