Struct holochain::prelude::kitsune_p2p::test_util::switchboard_evt_handler::SwitchboardEventHandler

pub struct SwitchboardEventHandler { /* private fields */ }

Stateful handler for KitsuneP2pEvents.

This is a very basic in-memory implementation of an event handler similar to what a Kitsune implementor like Holochain would implement. It’s used to implement nodes in the Switchboard.

Implementations

impl SwitchboardEventHandler

pub fn new(node: Tx2EpHnd<Wire>, sb: Switchboard) -> SwitchboardEventHandler

Constructor

Trait Implementations

impl Clone for SwitchboardEventHandler

fn clone(&self) -> SwitchboardEventHandler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl FetchPoolConfig for SwitchboardEventHandler

fn merge_fetch_contexts(&self, _a: u32, _b: u32) -> u32

When a fetch key is added twice, this determines how the two different contexts get reconciled.

fn item_retry_delay(&self) -> Duration

How long between successive item fetches, regardless of source? This gives a source a fair chance to respond before proceeding with a different source.

fn source_retry_delay(&self) -> Duration

How long between successive fetches from a particular source, for a particular item? This protects us from wasting resources on a source which may be offline. This will eventually be replaced with an exponential backoff which will be tracked for this source across all items.

impl GhostControlHandler for SwitchboardEventHandler

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

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

impl GhostHandler<KitsuneP2pEvent> for SwitchboardEventHandler

fn ghost_actor_dispatch(&mut self, d: D)

Process a dispatch event with this GhostHandler.

impl KitsuneHost for SwitchboardEventHandler

fn block( &self, _input: Block ) -> MustBoxFuture<'_, Result<(), Box<dyn Error + Send + Sync + 'static, Global>>>

We are requesting a block.

fn unblock( &self, _input: Block ) -> MustBoxFuture<'_, Result<(), Box<dyn Error + Send + Sync + 'static, Global>>>

We are requesting an unblock.

fn is_blocked( &self, _input: BlockTargetId, _timestamp: Timestamp ) -> MustBoxFuture<'_, Result<bool, Box<dyn Error + Send + Sync + 'static, Global>>>

We want to know if a target is blocked.

fn get_agent_info_signed( &self, _: GetAgentInfoSignedEvt ) -> MustBoxFuture<'_, Result<Option<AgentInfoSigned>, Box<dyn Error + Send + Sync + 'static, Global>>>

We need to get previously stored agent info.

fn remove_agent_info_signed( &self, _: GetAgentInfoSignedEvt ) -> MustBoxFuture<'_, Result<bool, Box<dyn Error + Send + Sync + 'static, Global>>>

Remove an agent info from storage

fn peer_extrapolated_coverage( &self, _space: Arc<KitsuneSpace>, _dht_arc_set: DhtArcSet ) -> MustBoxFuture<'_, Result<Vec<f64, Global>, Box<dyn Error + Send + Sync + 'static, Global>>>

Extrapolated Peer Coverage.

fn record_metrics( &self, _space: Arc<KitsuneSpace>, _records: Vec<MetricRecord, Global> ) -> MustBoxFuture<'_, Result<(), Box<dyn Error + Send + Sync + 'static, Global>>>

Record a set of metric records.

fn query_size_limited_regions( &self, _space: Arc<KitsuneSpace>, _size_limit: u32, regions: Vec<Region<RegionData>, Global> ) -> MustBoxFuture<'_, Result<Vec<Region<RegionData>, Global>, Box<dyn Error + Send + Sync + 'static, Global>>>

Given an input list of regions, return a list of equal or greater length such that each region’s size is less than the size_limit, by recursively subdividing regions which are over the size limit.

fn query_region_set( &self, space: Arc<KitsuneSpace>, dht_arc_set: Arc<DhtArcSet> ) -> MustBoxFuture<'_, Result<RegionSetLtcs<RegionData>, Box<dyn Error + Send + Sync + 'static, Global>>>

Query aggregate dht op data to form an LTCS set of region data.

fn get_topology( &self, _space: Arc<KitsuneSpace> ) -> MustBoxFuture<'_, Result<Topology, Box<dyn Error + Send + Sync + 'static, Global>>>

Get the quantum Topology associated with this Space.

fn op_hash( &self, _op_data: Arc<KitsuneOpData> ) -> MustBoxFuture<'_, Result<Arc<KitsuneOpHash>, Box<dyn Error + Send + Sync + 'static, Global>>>

Hashing function to get an op_hash from op_data.

fn query_op_hashes_by_region( &self, _space: Arc<KitsuneSpace>, _region: RegionCoords ) -> MustBoxFuture<'_, Result<Vec<RoughSized<Arc<KitsuneOpHash>>, Global>, Box<dyn Error + Send + Sync + 'static, Global>>>

Get all op hashes within a region

fn check_op_data( &self, space: Arc<KitsuneSpace>, op_hash_list: Vec<Arc<KitsuneOpHash>, Global>, _context: Option<FetchContext> ) -> MustBoxFuture<'_, Result<Vec<bool, Global>, Box<dyn Error + Send + Sync + 'static, Global>>>

Check which hashes we have data for.

fn lair_tag(&self) -> Option<Arc<str>>

Get the lair “tag” identifying the id seed to use for crypto signing. (this is currently only used in tx5/WebRTC if that feature is enabled.)

fn lair_client(&self) -> Option<LairClient>

Get the lair client to use as the backend keystore. (this is currently only used in tx5/WebRTC if that feature is enabled.)

impl KitsuneP2pEventHandler for SwitchboardEventHandler

fn handle_put_agent_info_signed( &mut self, _: PutAgentInfoSignedEvt ) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

We need to store signed agent info.

fn handle_query_agents( &mut self, _: QueryAgentsEvt ) -> Result<MustBoxFuture<'static, Result<Vec<AgentInfoSigned, Global>, KitsuneP2pError>>, KitsuneP2pError>

We need to get previously stored agent info.

fn handle_query_peer_density( &mut self, space: Arc<KitsuneSpace>, dht_arc: DhtArc ) -> Result<MustBoxFuture<'static, Result<PeerView, KitsuneP2pError>>, KitsuneP2pError>

Query the peer density of a space for a given [DhtArc].

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

We are receiving a request from a remote node.

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

We are receiving a notification from a remote node.

fn handle_receive_ops( &mut self, _space: Arc<KitsuneSpace>, ops: Vec<Arc<KitsuneOpData>, Global>, _context: Option<FetchContext> ) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>

We have received ops to be integrated, either through gossip or publish.

fn handle_query_op_hashes( &mut self, _: QueryOpHashesEvt ) -> Result<MustBoxFuture<'static, Result<Option<(Vec<Arc<KitsuneOpHash>, Global>, RangeInclusive<Timestamp>)>, KitsuneP2pError>>, KitsuneP2pError>

Gather a list of op-hashes from our implementor that meet criteria. Get the oldest and newest times for ops within a time window and max number of ops.

fn handle_fetch_op_data( &mut self, _: FetchOpDataEvt ) -> Result<MustBoxFuture<'static, Result<Vec<(Arc<KitsuneOpHash>, Arc<KitsuneOpData>), Global>, KitsuneP2pError>>, KitsuneP2pError>

Gather all op-hash data for a list of op-hashes from our implementor.

fn handle_sign_network_data( &mut self, input: SignNetworkDataEvt ) -> Result<MustBoxFuture<'static, Result<KitsuneSignature, KitsuneP2pError>>, KitsuneP2pError>

Request that our implementor sign some data on behalf of an agent.