Enum kitsune_p2p::actor::KitsuneP2p

pub enum KitsuneP2p {
    ListTransportBindings {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<Vec<Url2>>>,
    },
    Join {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<()>>,
        space: Arc<KitsuneSpace>,
        agent: Arc<KitsuneAgent>,
    },
    Leave {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<()>>,
        space: Arc<KitsuneSpace>,
        agent: Arc<KitsuneAgent>,
    },
    RpcSingle {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<Vec<u8>>>,
        space: Arc<KitsuneSpace>,
        to_agent: Arc<KitsuneAgent>,
        payload: Vec<u8>,
        timeout_ms: Option<u64>,
    },
    RpcMulti {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<Vec<RpcMultiResponse>>>,
        input: RpcMulti,
    },
    Broadcast {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<()>>,
        space: Arc<KitsuneSpace>,
        basis: Arc<KitsuneBasis>,
        timeout: KitsuneTimeout,
        destination: BroadcastTo,
        payload: Vec<u8>,
    },
    TargetedBroadcast {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<()>>,
        space: Arc<KitsuneSpace>,
        agents: Vec<Arc<KitsuneAgent>>,
        timeout: KitsuneTimeout,
        payload: Vec<u8>,
        drop_at_limit: bool,
    },
    NewIntegratedData {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<()>>,
        space: Arc<KitsuneSpace>,
    },
    AuthorityForHash {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<bool>>,
        space: Arc<KitsuneSpace>,
        basis: Arc<KitsuneBasis>,
    },
    DumpNetworkMetrics {
        span_context: Context,
        respond: GhostRespond<KitsuneP2pHandlerResult<Value>>,
        space: Option<Arc<KitsuneSpace>>,
    },
}

The KitsuneP2pSender allows async remote-control of the KitsuneP2p actor.

Variants

ListTransportBindings

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<Vec<Url2>>>

Response callback - respond to the request.

Get the calculated transport bindings.

Join

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<()>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

agent: Arc<KitsuneAgent>

Input parameter.

Announce a space/agent pair on this network.

Leave

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<()>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

agent: Arc<KitsuneAgent>

Input parameter.

Withdraw this space/agent pair from this network.

RpcSingle

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<Vec<u8>>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

to_agent: Arc<KitsuneAgent>

Input parameter.

payload: Vec<u8>

Input parameter.

timeout_ms: Option<u64>

Input parameter.

Make a request of a single remote agent, expecting a response. The remote side will receive a “Call” event.

RpcMulti

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<Vec<RpcMultiResponse>>>

Response callback - respond to the request.

input: RpcMulti

Input parameter.

Make a request to multiple destination agents - awaiting/aggregating the responses. The remote sides will see these messages as “Call” events.

Broadcast

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<()>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

basis: Arc<KitsuneBasis>

Input parameter.

timeout: KitsuneTimeout

Input parameter.

destination: BroadcastTo

Input parameter.

payload: Vec<u8>

Input parameter.

Publish data to a “neighborhood” of remote nodes surrounding the “basis” hash. This is a multi-step fire-and-forget algorithm. An Ok(()) result only means that we were able to establish at least one connection with a node in the target neighborhood. The remote sides will see these messages as “Notify” events.

TargetedBroadcast

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<()>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

agents: Vec<Arc<KitsuneAgent>>

Input parameter.

timeout: KitsuneTimeout

Input parameter.

payload: Vec<u8>

Input parameter.

drop_at_limit: bool

Input parameter.

Broadcast data to a specific set of agents without expecting a response. An Ok(()) result only means that we were able to establish at least one connection with a node in the agent set.

NewIntegratedData

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<()>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

New data has been integrated and is ready for gossiping.

AuthorityForHash

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<bool>>

Response callback - respond to the request.

space: Arc<KitsuneSpace>

Input parameter.

basis: Arc<KitsuneBasis>

Input parameter.

Check if an agent is an authority for a hash.

DumpNetworkMetrics

Fields

span_context: Context

Tracing span from request invocation.

respond: GhostRespond<KitsuneP2pHandlerResult<Value>>

Response callback - respond to the request.

space: Option<Arc<KitsuneSpace>>

Input parameter.

dump network metrics

Trait Implementations

impl Debug for KitsuneP2p

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

Formats the value using the given formatter.

impl<H: KitsuneP2pHandler> GhostDispatch<H> for KitsuneP2p

fn ghost_actor_dispatch(self, h: &mut H)

Process a dispatch event with a given GhostHandler.

impl GhostEvent for KitsuneP2p