PeerStore

kitsune2_api

Trait PeerStore 

Source 
pub trait PeerStore:
    'static
    + Send
    + Sync
    + Debug {
    // Required methods
    fn insert(
        &self,
        agent_list: Vec<Arc<AgentInfoSigned>>,
    ) -> BoxFut<'_, K2Result<()>>;
    fn remove(&self, agent_id: AgentId) -> BoxFut<'_, K2Result<()>>;
    fn get(
        &self,
        agent: AgentId,
    ) -> BoxFut<'_, K2Result<Option<Arc<AgentInfoSigned>>>>;
    fn get_all(&self) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>;
    fn get_by_overlapping_storage_arc(
        &self,
        arc: DhtArc,
    ) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>;
    fn get_near_location(
        &self,
        loc: u32,
        limit: usize,
    ) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>;
    fn get_by_url(
        &self,
        peer_url: Url,
    ) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>;

    // Provided method
    fn register_peer_update_listener(
        &self,
        _listener: Arc<dyn Fn(Arc<AgentInfoSigned>) -> BoxFut<'static, ()> + Send + Sync>,
    ) -> K2Result<()> { ... }
}
Expand description

Represents the ability to store and query agents.

Required Methods§

Source

fn insert( &self, agent_list: Vec<Arc<AgentInfoSigned>>, ) -> BoxFut<'_, K2Result<()>>

Insert agents into the store so long as they are not blocked.

Note: It is expected that the implementation of this method will respect the blocking of agents done by Blocks. Therefore it is important to call Blocks::is_blocked before inserting the passed agent.

Source

fn remove(&self, agent_id: AgentId) -> BoxFut<'_, K2Result<()>>

Remove agent from the store with the passed AgentId.

Note: If the agent is not also blocked via Blocks::block() then they will likely be re-inserted shortly after removal. It is recommended to first block and then remove.

Source

fn get( &self, agent: AgentId, ) -> BoxFut<'_, K2Result<Option<Arc<AgentInfoSigned>>>>

Get an agent from the store.

Source

fn get_all(&self) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>

Get all agents from the store.

Source

fn get_by_overlapping_storage_arc( &self, arc: DhtArc, ) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>

Get the complete list of agents we know about that claim storage_arcs that overlap the provided storage arc. This function, provided with the storage arc of a currently active local agent, will return a list of agents with whom to gossip (and also the local agent). If there are multiple local agents in this space, you’ll need to call this function multiple times and union the results.

Source

fn get_near_location( &self, loc: u32, limit: usize, ) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>

Get a list of agents sorted by nearness to a target basis location. Offline (tombstoned) agents, and agents with zero arcs are not included in the returned list.

Source

fn get_by_url( &self, peer_url: Url, ) -> BoxFut<'_, K2Result<Vec<Arc<AgentInfoSigned>>>>

Get a list of agents that are reachable at the passed Url.

Provided Methods§

Source

fn register_peer_update_listener( &self, _listener: Arc<dyn Fn(Arc<AgentInfoSigned>) -> BoxFut<'static, ()> + Send + Sync>, ) -> K2Result<()>

Register a listener that will be called whenever a peer is added or updated in the store.

Implementors§