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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
// 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::section::SectionChain; use bls_signature_aggregator::Proof; use bytes::Bytes; use ed25519_dalek::Keypair; use hex_fmt::HexFmt; pub use qp2p::{RecvStream, SendStream}; use sn_messaging::{client::Message, DstLocation, EndUser, SrcLocation}; use std::{ collections::BTreeSet, fmt::{self, Debug, Formatter}, net::SocketAddr, 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, } /// 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)] pub enum Event { /// Received a message. MessageReceived { /// The content of the message. content: Bytes, /// The source location that sent the message. src: SrcLocation, /// The destination location that receives the message. dst: DstLocation, /// The proof if the message was set to be aggregated at source. proof: Option<Proof>, /// The proof chain for the message, if any. proof_chain: Option<SectionChain>, }, /// 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, }, /// The set of elders in our section has changed. EldersChanged { /// The prefix of our section. prefix: Prefix, /// The BLS public key of our section. key: bls::PublicKey, /// The BLS public key of the sibling section, if this event is fired during a split. /// Otherwise `None`. sibling_key: Option<bls::PublicKey>, /// The set of elders of our section. elders: BTreeSet<XorName>, /// 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. new_keypair: Arc<Keypair>, }, /// Disconnected or failed to connect - restart required. RestartRequired, /// Received a message from a client node. ClientMessageReceived { /// The content of the message. msg: Box<Message>, /// The SocketAddr and PublicKey that sent the message. /// (Note: socket_id will be a random hash, to map against the actual socketaddr) user: EndUser, }, /// Failed in sending a message to client, or connection to client is lost ClientLost(SocketAddr), /// Notify the current list of adult nodes, in case of churning. AdultsChanged(BTreeSet<XorName>), } impl Debug for Event { fn fmt(&self, formatter: &mut Formatter) -> fmt::Result { match self { Self::MessageReceived { content, src, dst, .. } => write!( formatter, "MessageReceived {{ content: \"{:<8}\", src: {:?}, dst: {:?} }}", HexFmt(content), src, dst ), Self::MemberJoined { name, previous_name, age, } => formatter .debug_struct("MemberJoined") .field("name", name) .field("previous_name", previous_name) .field("age", age) .finish(), Self::MemberLeft { name, age } => formatter .debug_struct("MemberLeft") .field("name", name) .field("age", age) .finish(), Self::EldersChanged { prefix, key, sibling_key, elders, self_status_change, } => formatter .debug_struct("EldersChanged") .field("prefix", prefix) .field("key", key) .field("sibling_key", sibling_key) .field("elders", elders) .field("self_status_change", self_status_change) .finish(), Self::RelocationStarted { previous_name } => formatter .debug_struct("RelocationStarted") .field("previous_name", previous_name) .finish(), Self::Relocated { previous_name, new_keypair, } => formatter .debug_struct("Relocated") .field("previous_name", previous_name) .field("new_keypair", new_keypair) .finish(), Self::RestartRequired => write!(formatter, "RestartRequired"), Self::ClientMessageReceived { msg, user, .. } => write!( formatter, "ClientMessageReceived {{ msg: {:?}, src: {:?} }}", msg, user, ), Self::ClientLost(addr) => write!(formatter, "ClientLost({:?})", addr), Self::AdultsChanged(adult_list) => write!(formatter, "AdultsChanged({:?})", adult_list), } } }