libp3p 0.0.0

libp3p
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// Copyright 2019 Stichting Organism
// Copyright (c) 2018-2019 Prime Type Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


use crate::{Id, NodeData};
use std::collections::BTreeMap;

/// topology module. Defines a strategy to link nodes together.
///
pub trait Module {
    /// a unique identifier name of the given module.
    ///
    /// Useful for debugs and monitoring modules' activities.
    fn name(&self) -> &'static str;

    /// select gossips (node's Id to talk about) to send to another node.
    ///
    fn select_gossips(
        &self,
        our_node: &NodeData,
        gossip_recipient: &NodeData,
        known_nodes: &BTreeMap<Id, NodeData>,
    ) -> BTreeMap<Id, NodeData>;

    /// update the Module's internal state based on the NodeData's subscribers
    /// and subscriptions.
    fn update(&mut self, our_node: &NodeData, known_nodes: &BTreeMap<Id, NodeData>);

    /// show the view of the module. This is the NodeData the module have
    /// selected as nodes of interest and/or relevant nodes to exchange
    /// gossips or any other messages.
    fn view(&self, known_nodes: &BTreeMap<Id, NodeData>, view: &mut BTreeMap<Id, NodeData>);
}

/// filter module, will be applied on the set of modules to filter out undesired nodes
pub trait FilterModule {
    fn name(&self) -> &'static str;

    /// take ownership of some tree of nodes and filter out nodes that needs to be
    /// removed based on the filtering policies.
    fn filter(
        &self,
        _our_node: &NodeData,
        _other_nodes: BTreeMap<Id, NodeData>,
    ) -> BTreeMap<Id, NodeData>;
}