Struct holochain::prelude::kitsune_p2p::actor::MockKitsuneP2pHandler

pub struct MockKitsuneP2pHandler { /* private fields */ }

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

Implementations

impl MockKitsuneP2pHandler

pub fn checkpoint(&mut self)

Validate that all current expectations for all methods have been satisfied, and discard them.

pub fn new() -> MockKitsuneP2pHandler

Create a new mock object with no expectations.

This method will not be generated if the real struct already has a new method. However, it will be generated if the struct implements a trait with a new method. The trait’s new method can still be called like <MockX as TraitY>::new

impl MockKitsuneP2pHandler

pub fn expect_handle_list_transport_bindings(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_list_transport_bindings method

pub fn expect_handle_join(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_join method

pub fn expect_handle_leave(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_leave method

pub fn expect_handle_rpc_single(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_rpc_single method

pub fn expect_handle_rpc_multi(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_rpc_multi method

pub fn expect_handle_broadcast(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_broadcast method

pub fn expect_handle_targeted_broadcast(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_targeted_broadcast method

pub fn expect_handle_new_integrated_data(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_new_integrated_data method

pub fn expect_handle_authority_for_hash(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_authority_for_hash method

pub fn expect_handle_dump_network_metrics(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_dump_network_metrics method

pub fn expect_handle_get_diagnostics(&mut self) -> &mut Expectation

Create an Expectation for mocking the handle_get_diagnostics method

Trait Implementations

impl Debug for MockKitsuneP2pHandler

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

Formats the value using the given formatter.

impl Default for MockKitsuneP2pHandler

fn default() -> MockKitsuneP2pHandler

Returns the “default value” for a type.

impl GhostControlHandler for MockKitsuneP2pHandler

fn handle_ghost_actor_shutdown(self) -> MustBoxFuture<'static, ()>

Called when the actor task loops ends. Allows for any needed cleanup / triggers.

impl GhostHandler<KitsuneP2p> for MockKitsuneP2pHandler

fn ghost_actor_dispatch(&mut self, d: D)

Process a dispatch event with this GhostHandler.

impl KitsuneP2pHandler for MockKitsuneP2pHandler

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

fn handle_list_transport_bindings(
    &mut self
) -> Result<MustBoxFuture<'static, Result<Vec<Url2, Global>, KitsuneP2pError>>, KitsuneP2pError>

Get the calculated transport bindings.

fn handle_join(
    &mut self,
    space: Arc<KitsuneSpace>,
    agent: Arc<KitsuneAgent>,
    initial_arc: Option<DhtArc>
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

Announce a space/agent pair on this network.

fn handle_leave(
    &mut self,
    space: Arc<KitsuneSpace>,
    agent: Arc<KitsuneAgent>
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

Withdraw this space/agent pair from this network.

fn handle_rpc_single(
    &mut self,
    space: Arc<KitsuneSpace>,
    to_agent: Arc<KitsuneAgent>,
    payload: Vec<u8, Global>,
    timeout_ms: Option<u64>
) -> Result<MustBoxFuture<'static, Result<Vec<u8, Global>, KitsuneP2pError>>, KitsuneP2pError>

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

fn handle_rpc_multi(
    &mut self,
    input: RpcMulti
) -> Result<MustBoxFuture<'static, Result<Vec<RpcMultiResponse, Global>, KitsuneP2pError>>, KitsuneP2pError>

Make a request to multiple destination agents - awaiting/aggregating the responses. The remote sides will see these messages as “Call” events. NOTE: We’ve currently disabled the “multi” part of this. It will still pick appropriate peers by basis, but will only make requests one at a time, returning the first success.

fn handle_broadcast(
    &mut self,
    space: Arc<KitsuneSpace>,
    basis: Arc<KitsuneBasis>,
    timeout: KitsuneTimeout,
    data: BroadcastData
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

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.

fn handle_targeted_broadcast(
    &mut self,
    space: Arc<KitsuneSpace>,
    agents: Vec<Arc<KitsuneAgent>, Global>,
    timeout: KitsuneTimeout,
    payload: Vec<u8, Global>,
    drop_at_limit: bool
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

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.

fn handle_new_integrated_data(
    &mut self,
    space: Arc<KitsuneSpace>
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

New data has been integrated and is ready for gossiping.

fn handle_authority_for_hash(
    &mut self,
    space: Arc<KitsuneSpace>,
    basis: Arc<KitsuneBasis>
) -> Result<MustBoxFuture<'static, Result<bool, KitsuneP2pError>>, KitsuneP2pError>

Check if an agent is an authority for a hash.

fn handle_dump_network_metrics(
    &mut self,
    space: Option<Arc<KitsuneSpace>>
) -> Result<MustBoxFuture<'static, Result<Value, KitsuneP2pError>>, KitsuneP2pError>

dump network metrics

fn handle_get_diagnostics(
    &mut self,
    space: Arc<KitsuneSpace>
) -> Result<MustBoxFuture<'static, Result<KitsuneDiagnostics, KitsuneP2pError>>, KitsuneP2pError>

Get data for diagnostics