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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
// Copyright 2021 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.
use crate::messaging::{
data::ServiceMsg,
system::{NodeCmd, NodeQuery, NodeQueryResponse},
AuthorityProof, DstLocation, EndUser, MessageId, ServiceAuth, SrcLocation,
};
use bls::PublicKey as BlsPublicKey;
use ed25519_dalek::Keypair;
use std::{collections::BTreeSet, sync::Arc};
use xor_name::{Prefix, XorName};
/// A flag in EldersChanged event, indicating
/// whether the node got promoted, demoted or did not change.
#[derive(Debug)]
pub enum NodeElderChange {
/// The node was promoted to Elder.
Promoted,
/// The node was demoted to Adult.
Demoted,
/// There was no change to the node.
None,
}
/// Bound name of elders and section_key, section_prefix info together.
#[derive(Debug, Clone, PartialEq)]
pub struct Elders {
/// The prefix of the section.
pub prefix: Prefix,
/// The BLS public key of a section.
pub key: BlsPublicKey,
/// Remaining Elders in our section.
pub remaining: BTreeSet<XorName>,
/// New Elders in our section.
pub added: BTreeSet<XorName>,
/// Removed Elders in our section.
pub removed: BTreeSet<XorName>,
}
/// An Event raised by a `Node` or `Client` via its event sender.
///
/// These are sent by sn_routing to the library's user. It allows the user to handle requests and
/// responses, and to react to changes in the network.
///
/// `Request` and `Response` events from section locations are only raised once the majority has
/// been reached, i.e. enough members of the section have sent the same message.
#[allow(clippy::large_enum_variant)]
#[derive(custom_debug::Debug)]
pub enum Event {
/// Received a message from another Node.
MessageReceived {
/// The message ID
msg_id: MessageId,
/// Source location
src: SrcLocation,
/// Destination location
dst: DstLocation,
/// The message.
msg: Box<MessageReceived>,
},
/// A new peer joined our section.
MemberJoined {
/// Name of the node
name: XorName,
/// Previous name before relocation or `None` if it is a new node.
previous_name: Option<XorName>,
/// Age of the node
age: u8,
},
/// A node left our section.
MemberLeft {
/// Name of the node
name: XorName,
/// Age of the node
age: u8,
},
/// Our section has split.
SectionSplit {
/// The Elders of our section.
elders: Elders,
/// The Elders of the sibling section.
sibling_elders: Elders,
/// Promoted, demoted or no change?
self_status_change: NodeElderChange,
},
/// The set of elders in our section has changed.
EldersChanged {
/// The Elders of our section.
elders: Elders,
/// Promoted, demoted or no change?
self_status_change: NodeElderChange,
},
/// This node has started relocating to other section. Will be followed by
/// `Relocated` when the node finishes joining the destination section.
RelocationStarted {
/// Previous name before relocation
previous_name: XorName,
},
/// This node has completed relocation to other section.
Relocated {
/// Old name before the relocation.
previous_name: XorName,
/// New keypair to be used after relocation.
#[debug(skip)]
new_keypair: Arc<Keypair>,
},
/// Received a message from a peer.
ServiceMsgReceived {
/// The message ID
msg_id: MessageId,
/// The content of the message.
msg: Box<ServiceMsg>,
/// Data authority
auth: AuthorityProof<ServiceAuth>,
/// The end user that sent the message.
/// Its xorname is derived from the client public key,
/// and the socket_id maps against the actual socketaddr
user: EndUser,
/// DstLocation for the message
dst_location: DstLocation,
},
/// Notify the current list of adult nodes, in case of churning.
AdultsChanged {
/// Remaining Adults in our section.
remaining: BTreeSet<XorName>,
/// New Adults in our section.
added: BTreeSet<XorName>,
/// Removed Adults in our section.
removed: BTreeSet<XorName>,
},
}
/// Type of messages that are received from a peer
#[derive(Debug, Clone)]
pub enum MessageReceived {
/// Cmds only sent a among Nodes in the network.
NodeCmd(NodeCmd),
/// Queries is a read-only operation.
NodeQuery(NodeQuery),
/// The response to a query, containing the query result.
NodeQueryResponse {
/// QueryResponse.
response: NodeQueryResponse,
/// ID of causing query.
correlation_id: MessageId,
},
}