Enum kitsune_p2p::wire::Wire

pub enum Wire {
    Failure(Failure),
    Call(Call),
    CallResp(CallResp),
    DelegateBroadcast(DelegateBroadcast),
    Broadcast(Broadcast),
    Gossip(Gossip),
    PeerGet(PeerGet),
    PeerGetResp(PeerGetResp),
    PeerQuery(PeerQuery),
    PeerQueryResp(PeerQueryResp),
    MetricExchange(MetricExchange),
}

KitsuneP2p Wire Protocol Top-Level Enum.

Variants

Failure(Failure)

Failure

Call(Call)

“Call” to the remote.

CallResp(CallResp)

“Call” response from the remote.

DelegateBroadcast(DelegateBroadcast)

“DelegateBroadcast” to the remote. Remote should in turn connect to nodes in neighborhood, and call “Notify” per broadcast algorithm. uses low-level notify, not request

Broadcast(Broadcast)

Fire-and-forget broadcast message. uses low-level notify, not request

Gossip(Gossip)

Gossip op with opaque data section, to be forwarded to gossip module. uses low-level notify, not request

PeerGet(PeerGet)

Ask a remote node if they know about a specific agent

PeerGetResp(PeerGetResp)

Response to a peer get

PeerQuery(PeerQuery)

Query a remote node for peers holding or nearest to holding a u32 location.

PeerQueryResp(PeerQueryResp)

Response to a peer query

MetricExchange(MetricExchange)

MetricsExchangeMessage

Implementations

impl Wire

pub fn failure(reason: String) -> Self

Variant constructor helper function.

pub fn call(
    space: Arc<KitsuneSpace>,
    to_agent: Arc<KitsuneAgent>,
    data: WireData
) -> Self

Variant constructor helper function.

pub fn call_resp(data: WireData) -> Self

Variant constructor helper function.

pub fn delegate_broadcast(
    space: Arc<KitsuneSpace>,
    basis: Arc<KitsuneBasis>,
    to_agent: Arc<KitsuneAgent>,
    mod_idx: u32,
    mod_cnt: u32,
    destination: BroadcastTo,
    data: WireData
) -> Self

Variant constructor helper function.

pub fn broadcast(
    space: Arc<KitsuneSpace>,
    to_agent: Arc<KitsuneAgent>,
    destination: BroadcastTo,
    data: WireData
) -> Self

Variant constructor helper function.

pub fn gossip(
    space: Arc<KitsuneSpace>,
    data: WireData,
    module: GossipModuleType
) -> Self

Variant constructor helper function.

pub fn peer_get(space: Arc<KitsuneSpace>, agent: Arc<KitsuneAgent>) -> Self

Variant constructor helper function.

pub fn peer_get_resp(agent_info_signed: AgentInfoSigned) -> Self

Variant constructor helper function.

pub fn peer_query(space: Arc<KitsuneSpace>, basis_loc: DhtLocation) -> Self

Variant constructor helper function.

pub fn peer_query_resp(peer_list: Vec<AgentInfoSigned>) -> Self

Variant constructor helper function.

pub fn metric_exchange(
    space: Arc<KitsuneSpace>,
    msgs: Vec<MetricExchangeMsg>
) -> Self

Variant constructor helper function.

Trait Implementations

impl Clone for Wire

fn clone(&self) -> Wire

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec for Wire

fn variant_type(&self) -> &'static str

Variant identifier (for debugging or as a cheap discriminant).

fn encode<W>(&self, w: &mut W) -> Result<()> where
    W: Write, 

Encode this item to given writer. You may wish to first wrap your writer in a BufWriter.

fn decode<R>(r: &mut R) -> Result<Self, Error> where
    R: Read, 

Decode a reader into this item. You may wish to first wrap your reader in a BufReader.

fn encode_vec(&self) -> Result<Vec<u8, Global>, Error>

Encode this item to an owned vector of bytes. Uses encode() internally.

fn decode_ref(r: &[u8]) -> Result<(u64, Self), Error>

Decode a range of bytes into this item. Will also return the byte count read. Uses decode() internally.

impl Debug for Wire

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

Formats the value using the given formatter.

impl PartialEq<Wire> for Wire

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

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

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

This method tests for !=.

impl StructuralPartialEq for Wire