pub struct SwitchboardEventHandler { /* private fields */ }
Expand description
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§
source§impl SwitchboardEventHandler
impl SwitchboardEventHandler
sourcepub fn new(node: Tx2EpHnd<Wire>, sb: Switchboard) -> SwitchboardEventHandler
pub fn new(node: Tx2EpHnd<Wire>, sb: Switchboard) -> SwitchboardEventHandler
Constructor
Trait Implementations§
source§impl Clone for SwitchboardEventHandler
impl Clone for SwitchboardEventHandler
source§fn clone(&self) -> SwitchboardEventHandler
fn clone(&self) -> SwitchboardEventHandler
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl FetchQueueConfig for SwitchboardEventHandler
impl FetchQueueConfig for SwitchboardEventHandler
source§fn merge_fetch_contexts(&self, _a: u32, _b: u32) -> u32
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
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. Read more
§fn source_retry_delay(&self) -> Duration
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.
source§impl GhostControlHandler for SwitchboardEventHandler
impl GhostControlHandler for SwitchboardEventHandler
source§fn handle_ghost_actor_shutdown(self) -> MustBoxFuture<'static, ()> ⓘ
fn handle_ghost_actor_shutdown(self) -> MustBoxFuture<'static, ()> ⓘ
Called when the actor task loops ends.
Allows for any needed cleanup / triggers.
source§impl GhostHandler<KitsuneP2pEvent> for SwitchboardEventHandler
impl GhostHandler<KitsuneP2pEvent> for SwitchboardEventHandler
source§fn ghost_actor_dispatch(&mut self, d: D)
fn ghost_actor_dispatch(&mut self, d: D)
Process a dispatch event with this GhostHandler.
source§impl KitsuneHost for SwitchboardEventHandler
impl KitsuneHost for SwitchboardEventHandler
source§fn get_agent_info_signed(
&self,
_: GetAgentInfoSignedEvt
) -> MustBoxFuture<'_, Result<Option<AgentInfoSigned>, Box<dyn Error + Send + Sync + 'static, Global>>> ⓘ
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.
source§fn peer_extrapolated_coverage(
&self,
_space: Arc<KitsuneSpace>,
_dht_arc_set: DhtArcSet
) -> MustBoxFuture<'_, Result<Vec<f64, Global>, Box<dyn Error + Send + Sync + 'static, Global>>> ⓘ
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.
source§fn record_metrics(
&self,
_space: Arc<KitsuneSpace>,
_records: Vec<MetricRecord, Global>
) -> MustBoxFuture<'_, Result<(), Box<dyn Error + Send + Sync + 'static, Global>>> ⓘ
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.
source§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>>> ⓘ
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.source§fn query_region_set(
&self,
space: Arc<KitsuneSpace>,
dht_arc_set: Arc<DhtArcSet>
) -> MustBoxFuture<'_, Result<RegionSetLtcs<RegionData>, Box<dyn Error + Send + Sync + 'static, Global>>> ⓘ
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.
source§fn get_topology(
&self,
_space: Arc<KitsuneSpace>
) -> MustBoxFuture<'_, Result<Topology, Box<dyn Error + Send + Sync + 'static, Global>>> ⓘ
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.
source§fn op_hash(
&self,
_op_data: Arc<KitsuneOpData>
) -> MustBoxFuture<'_, Result<Arc<KitsuneOpHash>, Box<dyn Error + Send + Sync + 'static, Global>>> ⓘ
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.
source§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>>> ⓘ
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
source§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>>> ⓘ
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.
source§impl KitsuneP2pEventHandler for SwitchboardEventHandler
impl KitsuneP2pEventHandler for SwitchboardEventHandler
source§fn handle_put_agent_info_signed(
&mut self,
_: PutAgentInfoSignedEvt
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>
fn handle_put_agent_info_signed(
&mut self,
_: PutAgentInfoSignedEvt
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>
We need to store signed agent info.
source§fn handle_query_agents(
&mut self,
_: QueryAgentsEvt
) -> Result<MustBoxFuture<'static, Result<Vec<AgentInfoSigned, Global>, KitsuneP2pError>>, KitsuneP2pError>
fn handle_query_agents(
&mut self,
_: QueryAgentsEvt
) -> Result<MustBoxFuture<'static, Result<Vec<AgentInfoSigned, Global>, KitsuneP2pError>>, KitsuneP2pError>
We need to get previously stored agent info.
source§fn handle_query_peer_density(
&mut self,
space: Arc<KitsuneSpace>,
dht_arc: DhtArc
) -> Result<MustBoxFuture<'static, Result<PeerView, KitsuneP2pError>>, KitsuneP2pError>
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
].source§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>
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.
source§fn handle_notify(
&mut self,
space: Arc<KitsuneSpace>,
to_agent: Arc<KitsuneAgent>,
payload: Vec<u8, Global>
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>
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.
source§fn handle_receive_ops(
&mut self,
_space: Arc<KitsuneSpace>,
ops: Vec<Arc<KitsuneOpData>, Global>,
_context: Option<FetchContext>
) -> Result<MustBoxFuture<'static, Result<(), KitsuneP2pError>>, KitsuneP2pError>
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.
source§fn handle_query_op_hashes(
&mut self,
_: QueryOpHashesEvt
) -> Result<MustBoxFuture<'static, Result<Option<(Vec<Arc<KitsuneOpHash>, Global>, RangeInclusive<Timestamp>)>, KitsuneP2pError>>, KitsuneP2pError>
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.
source§fn handle_fetch_op_data(
&mut self,
_: FetchOpDataEvt
) -> Result<MustBoxFuture<'static, Result<Vec<(Arc<KitsuneOpHash>, Arc<KitsuneOpData>), Global>, KitsuneP2pError>>, KitsuneP2pError>
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.
source§fn handle_sign_network_data(
&mut self,
input: SignNetworkDataEvt
) -> Result<MustBoxFuture<'static, Result<KitsuneSignature, KitsuneP2pError>>, KitsuneP2pError>
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.
Auto Trait Implementations§
impl !RefUnwindSafe for SwitchboardEventHandler
impl Send for SwitchboardEventHandler
impl Sync for SwitchboardEventHandler
impl Unpin for SwitchboardEventHandler
impl !UnwindSafe for SwitchboardEventHandler
Blanket Implementations§
§impl<T> Any for Twhere
T: Any + ?Sized,
impl<T> Any for Twhere
T: Any + ?Sized,
§fn type_id_compat(&self) -> TypeId
fn type_id_compat(&self) -> TypeId
TODO: once 1.33.0 is the minimum supported compiler version, remove
Any::type_id_compat and use StdAny::type_id instead.
https://github.com/rust-lang/rust/issues/27745
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
§impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
§fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
Deserializes using the given deserializer
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.§impl<T> Upcastable for Twhere
T: 'static + Any + Send + Sync,
impl<T> Upcastable for Twhere
T: 'static + Any + Send + Sync,
§fn upcast_any_ref(&self) -> &(dyn Any + 'static)
fn upcast_any_ref(&self) -> &(dyn Any + 'static)
upcast ref
§fn upcast_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn upcast_any_mut(&mut self) -> &mut (dyn Any + 'static)
upcast mut ref