From ed2eb8d9c2c978f1edd59830f5eac46efa6688c9 Mon Sep 17 00:00:00 2001 From: librelois <elois@ifee.fr> Date: Sat, 11 May 2019 16:37:54 +0200 Subject: [PATCH] [ref] ws2p: rename WS2PModule->WS2Pv1Module & WS2Pv2Module->WS2PModule --- bin/durs-server/src/cli.rs | 4 +-- bin/durs-server/src/main.rs | 13 ++++--- doc/en/dev/developing-a-durs-module.md | 4 +-- .../developpeurs/developper-un-module-durs.md | 4 +-- .../ws2p-v1-legacy/src/events/received.rs | 4 +-- lib/modules/ws2p-v1-legacy/src/events/sent.rs | 6 ++-- lib/modules/ws2p-v1-legacy/src/lib.rs | 36 +++++++++---------- .../ws2p-v1-legacy/src/requests/received.rs | 4 +-- .../ws2p-v1-legacy/src/requests/sent.rs | 6 ++-- .../ws2p-v1-legacy/src/responses/sent.rs | 4 +-- .../src/ws_connections/messages.rs | 2 +- .../ws2p-v1-legacy/src/ws_connections/mod.rs | 13 ++++--- .../src/ws_connections/requests/sent.rs | 4 +-- lib/modules/ws2p/ws2p/src/lib.rs | 14 ++++---- 14 files changed, 62 insertions(+), 56 deletions(-) diff --git a/bin/durs-server/src/cli.rs b/bin/durs-server/src/cli.rs index 7db099f7..606d4bc9 100644 --- a/bin/durs-server/src/cli.rs +++ b/bin/durs-server/src/cli.rs @@ -26,7 +26,7 @@ use durs_core::commands::{ use durs_core::errors::DursCoreError; use durs_core::DursCore; use durs_network::cli::sync::SyncOpt; -use durs_ws2p_v1_legacy::{WS2PModule, WS2POpt}; +use durs_ws2p_v1_legacy::{WS2POpt, WS2Pv1Module}; use log::Level; use std::path::PathBuf; use structopt::StructOpt; @@ -64,7 +64,7 @@ impl ExecutableModuleCommand for DursCliOpt { fn execute_module_command(self, options: DursCoreOptions) -> Result<(), DursCoreError> { match self.cmd { DursCliSubCommand::Ws2p1(module_opts) => { - DursCore::execute_module_command::<WS2PModule>( + DursCore::execute_module_command::<WS2Pv1Module>( options, module_opts, env!("CARGO_PKG_NAME"), diff --git a/bin/durs-server/src/main.rs b/bin/durs-server/src/main.rs index f5807171..f95046c3 100644 --- a/bin/durs-server/src/main.rs +++ b/bin/durs-server/src/main.rs @@ -39,8 +39,8 @@ use structopt::StructOpt; #[cfg(unix)] pub use durs_tui::TuiModule; //pub use durs_skeleton::SkeletonModule; -pub use durs_ws2p_v1_legacy::{WS2PModule, WS2POpt}; -//pub use durs_ws2p::WS2Pv2Module; +//pub use durs_ws2p::WS2PModule; +pub use durs_ws2p_v1_legacy::WS2Pv1Module; /// Durs cli main macro macro_rules! durs_cli_main { @@ -62,16 +62,19 @@ macro_rules! durs_cli_main { #[cfg(not(target_arch = "arm"))] fn main() { durs_cli_main!(durs_plug!( - [WS2PModule], + [WS2Pv1Module], [TuiModule /*, SkeletonModule ,DasaModule*/] )) } #[cfg(unix)] #[cfg(target_arch = "arm")] fn main() { - durs_cli_main!(durs_plug!([WS2PModule], [TuiModule /*, SkeletonModule*/])) + durs_cli_main!(durs_plug!( + [WS2Pv1Module], + [TuiModule /*, SkeletonModule*/] + )) } #[cfg(windows)] fn main() { - durs_cli_main!(durs_plug!([WS2PModule], [])) + durs_cli_main!(durs_plug!([WS2Pv1Module], [])) } diff --git a/doc/en/dev/developing-a-durs-module.md b/doc/en/dev/developing-a-durs-module.md index 4454ef41..f3716043 100644 --- a/doc/en/dev/developing-a-durs-module.md +++ b/doc/en/dev/developing-a-durs-module.md @@ -274,12 +274,12 @@ Once you added your module in `durs-server` dependencies as shown above, you'll 2. Add your module to the macro `durs_plug!` : - durs_plug!([WS2PModule], [TuiModule, .., TotoModule]) + durs_plug!([WS2Pv1Module], [TuiModule, .., TotoModule]) Its first argument is a list of modules of type network inter-node. Other modules go into the second list. 3. If your module injects a subcommand, add it to the `durs_inject_cli!` macro: - durs_inject_cli![WS2PModule, .., TotoModule], + durs_inject_cli![WS2Pv1Module, .., TotoModule], And now ping us if you want more tutorial… diff --git a/doc/fr/developpeurs/developper-un-module-durs.md b/doc/fr/developpeurs/developper-un-module-durs.md index 22923903..5a3e2ee0 100644 --- a/doc/fr/developpeurs/developper-un-module-durs.md +++ b/doc/fr/developpeurs/developper-un-module-durs.md @@ -293,13 +293,13 @@ Une fois que vous avez ajouté votre module en dépendance dans le Cargo.toml de 2. Ajoutez votre module en paramètre de la macro `durs_plug!` : - durs_plug!([WS2PModule], [TuiModule, .., TotoModule]) + durs_plug!([WS2Pv1Module], [TuiModule, .., TotoModule]) Notez que `durs_plug!` prend en paramètre 2 tableaux de modules, le 1er correspond aux modules de type réseau inter-nœuds, tous les autres modules doivent se trouver dans le 2ème tableau. 3. Si votre module doit injecter une sous-commande dans la ligne de commande `durs`, ajoutez le également a la macro `durs_inject_cli!` : - durs_inject_cli![WS2PModule, .., TotoModule], + durs_inject_cli![WS2Pv1Module, .., TotoModule], La macro `durs_inject_cli!` n'accepte qu'un seul tableau qui doit comporter tous les modules injectant une sous-commande, pas de distinction ici. diff --git a/lib/modules/ws2p-v1-legacy/src/events/received.rs b/lib/modules/ws2p-v1-legacy/src/events/received.rs index be090fba..2bed2025 100644 --- a/lib/modules/ws2p-v1-legacy/src/events/received.rs +++ b/lib/modules/ws2p-v1-legacy/src/events/received.rs @@ -22,7 +22,7 @@ use durs_module::*; use std::ops::Deref; pub fn receive_event( - ws2p_module: &mut WS2PModule, + ws2p_module: &mut WS2Pv1Module, _event_type: ModuleEvent, event_content: &DursEvent, ) { @@ -31,7 +31,7 @@ pub fn receive_event( BlockchainEvent::StackUpValidBlock(ref block) => { ws2p_module.current_blockstamp = block.deref().blockstamp(); debug!( - "WS2PModule : current_blockstamp = {}", + "WS2Pv1Module : current_blockstamp = {}", ws2p_module.current_blockstamp ); ws2p_module.my_head = Some(heads::generate_my_head( diff --git a/lib/modules/ws2p-v1-legacy/src/events/sent.rs b/lib/modules/ws2p-v1-legacy/src/events/sent.rs index 3581d4c7..16750ed8 100644 --- a/lib/modules/ws2p-v1-legacy/src/events/sent.rs +++ b/lib/modules/ws2p-v1-legacy/src/events/sent.rs @@ -15,20 +15,20 @@ //! Sub-module managing the events emitted by the blockchain module. -use crate::WS2PModule; +use crate::WS2Pv1Module; use durs_message::events::DursEvent; use durs_message::*; use durs_module::{ModuleEvent, RouterThreadMessage}; use durs_network::documents::BlockchainDocument; use durs_network::events::NetworkEvent; -pub fn send_network_events(ws2p_module: &mut WS2PModule, events: Vec<NetworkEvent>) { +pub fn send_network_events(ws2p_module: &mut WS2Pv1Module, events: Vec<NetworkEvent>) { for event in events { send_network_event(ws2p_module, event); } } -pub fn send_network_event(ws2p_module: &mut WS2PModule, event: NetworkEvent) { +pub fn send_network_event(ws2p_module: &mut WS2Pv1Module, event: NetworkEvent) { let module_event = match event { NetworkEvent::ConnectionStateChange(_, _, _, _) => { ModuleEvent::ConnectionsChangeNodeNetwork diff --git a/lib/modules/ws2p-v1-legacy/src/lib.rs b/lib/modules/ws2p-v1-legacy/src/lib.rs index 768ab210..bbc49085 100644 --- a/lib/modules/ws2p-v1-legacy/src/lib.rs +++ b/lib/modules/ws2p-v1-legacy/src/lib.rs @@ -199,7 +199,7 @@ pub enum SendRequestError { } #[derive(Debug)] -pub struct WS2PModule { +pub struct WS2Pv1Module { pub conf: WS2PConf, pub count_dal_requests: u32, pub currency: Option<String>, @@ -225,15 +225,15 @@ pub struct WS2PModule { pub uids_cache: HashMap<PubKey, String>, } -impl WS2PModule { +impl WS2Pv1Module { pub fn new( soft_meta_datas: &SoftwareMetaDatas<DuRsConf>, conf: WS2PConf, ep_file_path: PathBuf, key_pair: KeyPairEnum, router_sender: mpsc::Sender<RouterThreadMessage<DursMsg>>, - ) -> WS2PModule { - WS2PModule { + ) -> WS2Pv1Module { + WS2Pv1Module { router_sender, key_pair, currency: None, @@ -290,7 +290,7 @@ pub enum WS2PFeaturesParseError { UnknowApiFeature(String), } -impl ApiModule<DuRsConf, DursMsg> for WS2PModule { +impl ApiModule<DuRsConf, DursMsg> for WS2Pv1Module { type ParseErr = WS2PFeaturesParseError; /// Parse raw api features fn parse_raw_api_features(str_features: &str) -> Result<ApiFeatures, Self::ParseErr> { @@ -312,7 +312,7 @@ impl ApiModule<DuRsConf, DursMsg> for WS2PModule { } } -impl NetworkModule<DuRsConf, DursMsg> for WS2PModule { +impl NetworkModule<DuRsConf, DursMsg> for WS2Pv1Module { fn sync( _soft_meta_datas: &SoftwareMetaDatas<DuRsConf>, _keys: RequiredKeysContent, @@ -346,7 +346,7 @@ macro_rules! fields_overload { }}; } -impl DursModule<DuRsConf, DursMsg> for WS2PModule { +impl DursModule<DuRsConf, DursMsg> for WS2Pv1Module { type ModuleUserConf = WS2PUserConf; type ModuleConf = WS2PConf; type ModuleOpt = WS2POpt; @@ -440,7 +440,7 @@ impl DursModule<DuRsConf, DursMsg> for WS2PModule { key_pair } else { return Err(ModuleInitError::FailToLoadConf( - "WS2PModule fatal error at load_conf() : keys != NetworkKeyPair", + "WS2Pv1Module fatal error at load_conf() : keys != NetworkKeyPair", )); }; @@ -472,8 +472,8 @@ impl DursModule<DuRsConf, DursMsg> for WS2PModule { } ep_file_path.push("endpoints.bin"); - // Define WS2PModule - let mut ws2p_module = WS2PModule::new( + // Define WS2Pv1Module + let mut ws2p_module = WS2Pv1Module::new( soft_meta_datas, conf, ep_file_path.clone(), @@ -523,7 +523,7 @@ impl DursModule<DuRsConf, DursMsg> for WS2PModule { // Send proxy sender to main router_sender .send(RouterThreadMessage::ModuleRegistration( - WS2PModule::name(), + WS2Pv1Module::name(), proxy_sender_clone, vec![ModuleRole::InterNodesNetwork], vec![ @@ -569,7 +569,7 @@ impl DursModule<DuRsConf, DursMsg> for WS2PModule { } } -impl WS2PModule { +impl WS2Pv1Module { fn main_loop(mut self, start_time: SystemTime, soft_meta_datas: &SoftwareMetaDatas<DuRsConf>) { // Initialize variables let key_pair = self.key_pair; @@ -612,7 +612,7 @@ impl WS2PModule { ref current_blockstamp_, ) => { debug!( - "WS2PModule : receive DALResBc::CurrentBlockstamp({})", + "WS2Pv1Module : receive DALResBc::CurrentBlockstamp({})", self.current_blockstamp ); self.current_blockstamp = *current_blockstamp_; @@ -687,7 +687,7 @@ impl WS2PModule { WS2PSignal::ConnectionEstablished(ws2p_full_id) => { let req_id = ModuleReqId(self.requests_awaiting_response.len() as u32); - let module_id = WS2PModule::name(); + let module_id = WS2Pv1Module::name(); debug!("WS2P: send req to: ({:?})", ws2p_full_id); let _current_request_result = ws_connections::requests::sent::send_request_to_specific_node( @@ -827,7 +827,7 @@ impl WS2PModule { req.get_req_full_id().0, req.get_req_full_id().1, NetworkResponse::CurrentBlock( - ModuleReqFullId(WS2PModule::name(), req_id), + ModuleReqFullId(WS2Pv1Module::name(), req_id), recipient_full_id, Box::new(block), ), @@ -845,7 +845,7 @@ impl WS2PModule { if let Some(block) = parse_json_block(json_block) { chunk.push(block); } else { - warn!("WS2PModule: Error : fail to parse one json block !"); + warn!("WS2Pv1Module: Error : fail to parse one json block !"); } } debug!("Send chunk to followers : {}", from); @@ -907,7 +907,7 @@ impl WS2PModule { } // Print current_blockstamp info!( - "WS2PModule : current_blockstamp() = {:?}", + "WS2Pv1Module : current_blockstamp() = {:?}", self.current_blockstamp ); // New WS2P connection wave @@ -1118,7 +1118,7 @@ mod tests { #[test] fn ws2p_requests() { - let module_id = WS2PModule::name(); + let module_id = WS2Pv1Module::name(); let request = OldNetworkRequest::GetBlocks(ModuleReqFullId(module_id, ModuleReqId(58)), 50, 0); assert_eq!( diff --git a/lib/modules/ws2p-v1-legacy/src/requests/received.rs b/lib/modules/ws2p-v1-legacy/src/requests/received.rs index 40add53d..838d2eff 100644 --- a/lib/modules/ws2p-v1-legacy/src/requests/received.rs +++ b/lib/modules/ws2p-v1-legacy/src/requests/received.rs @@ -17,11 +17,11 @@ use crate::ws2p_db::DbEndpoint; use crate::ws_connections::states::WS2PConnectionState; -use crate::WS2PModule; +use crate::WS2Pv1Module; use durs_message::requests::DursReqContent; use durs_network::requests::OldNetworkRequest; -pub fn receive_req(ws2p_module: &mut WS2PModule, req_content: &DursReqContent) { +pub fn receive_req(ws2p_module: &mut WS2Pv1Module, req_content: &DursReqContent) { if let DursReqContent::OldNetworkRequest(ref old_net_request) = *req_content { match *old_net_request { OldNetworkRequest::GetBlocks(ref req_id, ref count, ref from) => { diff --git a/lib/modules/ws2p-v1-legacy/src/requests/sent.rs b/lib/modules/ws2p-v1-legacy/src/requests/sent.rs index 33a58210..ad8963e5 100644 --- a/lib/modules/ws2p-v1-legacy/src/requests/sent.rs +++ b/lib/modules/ws2p-v1-legacy/src/requests/sent.rs @@ -15,12 +15,12 @@ //! Sub-module managing the inter-modules requests sent. -use crate::WS2PModule; +use crate::WS2Pv1Module; use durs_message::requests::{BlockchainRequest, DursReqContent}; use durs_message::*; use durs_module::{DursModule, ModuleReqId, ModuleRole, RouterThreadMessage}; -pub fn send_dal_request(ws2p_module: &mut WS2PModule, req: &BlockchainRequest) { +pub fn send_dal_request(ws2p_module: &mut WS2Pv1Module, req: &BlockchainRequest) { ws2p_module.count_dal_requests += 1; if ws2p_module.count_dal_requests == std::u32::MAX { ws2p_module.count_dal_requests = 0; @@ -28,7 +28,7 @@ pub fn send_dal_request(ws2p_module: &mut WS2PModule, req: &BlockchainRequest) { ws2p_module .router_sender .send(RouterThreadMessage::ModuleMessage(DursMsg::Request { - req_from: WS2PModule::name(), + req_from: WS2Pv1Module::name(), req_to: ModuleRole::BlockchainDatas, req_id: ModuleReqId(ws2p_module.count_dal_requests), req_content: DursReqContent::BlockchainRequest(req.clone()), diff --git a/lib/modules/ws2p-v1-legacy/src/responses/sent.rs b/lib/modules/ws2p-v1-legacy/src/responses/sent.rs index f102489c..1e576ef5 100644 --- a/lib/modules/ws2p-v1-legacy/src/responses/sent.rs +++ b/lib/modules/ws2p-v1-legacy/src/responses/sent.rs @@ -19,7 +19,7 @@ use crate::*; use durs_message::*; pub fn send_network_req_response( - ws2p_module: &WS2PModule, + ws2p_module: &WS2Pv1Module, requester: ModuleStaticName, req_id: ModuleReqId, response: NetworkResponse, @@ -27,7 +27,7 @@ pub fn send_network_req_response( ws2p_module .router_sender .send(RouterThreadMessage::ModuleMessage(DursMsg::Response { - res_from: WS2PModule::name(), + res_from: WS2Pv1Module::name(), res_to: requester, req_id, res_content: DursResContent::NetworkResponse(response), diff --git a/lib/modules/ws2p-v1-legacy/src/ws_connections/messages.rs b/lib/modules/ws2p-v1-legacy/src/ws_connections/messages.rs index 08724c4a..158b2530 100644 --- a/lib/modules/ws2p-v1-legacy/src/ws_connections/messages.rs +++ b/lib/modules/ws2p-v1-legacy/src/ws_connections/messages.rs @@ -67,7 +67,7 @@ pub fn generate_connect_message( } pub fn ws2p_conn_message_pretreatment( - ws2p_module: &mut WS2PModule, + ws2p_module: &mut WS2Pv1Module, message: WS2PConnectionMessage, ) -> WS2PSignal { let ws2p_full_id = message.0; diff --git a/lib/modules/ws2p-v1-legacy/src/ws_connections/mod.rs b/lib/modules/ws2p-v1-legacy/src/ws_connections/mod.rs index dfe35c5e..0e302806 100644 --- a/lib/modules/ws2p-v1-legacy/src/ws_connections/mod.rs +++ b/lib/modules/ws2p-v1-legacy/src/ws_connections/mod.rs @@ -51,7 +51,7 @@ pub enum WS2PCloseConnectionReason { Unknow, } -pub fn connect_to_know_endpoints(ws2p_module: &mut WS2PModule) { +pub fn connect_to_know_endpoints(ws2p_module: &mut WS2Pv1Module) { info!("WS2P: connect to know endpoints..."); let mut count_established_connections = 0; let mut pubkeys = HashSet::new(); @@ -108,7 +108,7 @@ pub fn connect_to_know_endpoints(ws2p_module: &mut WS2PModule) { } } -pub fn connect_to(ws2p_module: &mut WS2PModule, ep: &EndpointV1) { +pub fn connect_to(ws2p_module: &mut WS2Pv1Module, ep: &EndpointV1) { // Add endpoint to endpoints list (if there isn't already) let node_full_id = ep .node_full_id() @@ -127,7 +127,10 @@ pub fn connect_to(ws2p_module: &mut WS2PModule, ep: &EndpointV1) { } } -pub fn connect_to_without_checking_quotas(ws2p_module: &mut WS2PModule, node_full_id: NodeFullId) { +pub fn connect_to_without_checking_quotas( + ws2p_module: &mut WS2Pv1Module, + node_full_id: NodeFullId, +) { let endpoint = unwrap!(ws2p_module.ws2p_endpoints.get(&node_full_id)); let endpoint_copy = endpoint.ep.clone(); let conductor_sender_copy = ws2p_module.main_thread_channel.0.clone(); @@ -144,7 +147,7 @@ pub fn connect_to_without_checking_quotas(ws2p_module: &mut WS2PModule, node_ful } pub fn close_connection( - ws2p_module: &mut WS2PModule, + ws2p_module: &mut WS2Pv1Module, ws2p_full_id: &NodeFullId, reason: WS2PCloseConnectionReason, ) { @@ -186,7 +189,7 @@ pub fn get_random_connection<S: ::std::hash::BuildHasher>( } } -pub fn count_established_connections(ws2p_module: &WS2PModule) -> usize { +pub fn count_established_connections(ws2p_module: &WS2Pv1Module) -> usize { let mut count_established_connections = 0; for DbEndpoint { state, .. } in ws2p_module.ws2p_endpoints.values() { if let WS2PConnectionState::Established = state { diff --git a/lib/modules/ws2p-v1-legacy/src/ws_connections/requests/sent.rs b/lib/modules/ws2p-v1-legacy/src/ws_connections/requests/sent.rs index dea15eae..b0f027e6 100644 --- a/lib/modules/ws2p-v1-legacy/src/ws_connections/requests/sent.rs +++ b/lib/modules/ws2p-v1-legacy/src/ws_connections/requests/sent.rs @@ -15,7 +15,7 @@ //! Sub-module managing the WS2Pv1 requests sent. -use crate::WS2PModule; +use crate::WS2Pv1Module; use durs_common_tools::fatal_error; use durs_network::requests::OldNetworkRequest; use durs_network_documents::NodeFullId; @@ -23,7 +23,7 @@ use std::time::SystemTime; use ws::Message; pub fn send_request_to_specific_node( - ws2p_module: &mut WS2PModule, + ws2p_module: &mut WS2Pv1Module, ws2p_full_id: &NodeFullId, ws2p_request: &OldNetworkRequest, ) -> ws::Result<()> { diff --git a/lib/modules/ws2p/ws2p/src/lib.rs b/lib/modules/ws2p/ws2p/src/lib.rs index 653fd29a..9a734f97 100644 --- a/lib/modules/ws2p/ws2p/src/lib.rs +++ b/lib/modules/ws2p/ws2p/src/lib.rs @@ -79,11 +79,11 @@ impl Default for WS2PConf { #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] /// WS2Pv2 Module -pub struct WS2Pv2Module {} +pub struct WS2PModule {} -impl Default for WS2Pv2Module { - fn default() -> WS2Pv2Module { - WS2Pv2Module {} +impl Default for WS2PModule { + fn default() -> WS2PModule { + WS2PModule {} } } @@ -94,7 +94,7 @@ pub enum WS2PFeaturesParseError { UnknowApiFeature(String), } -impl ApiModule<DuRsConf, DursMsg> for WS2Pv2Module { +impl ApiModule<DuRsConf, DursMsg> for WS2PModule { type ParseErr = WS2PFeaturesParseError; /// Parse raw api features fn parse_raw_api_features(str_features: &str) -> Result<ApiFeatures, Self::ParseErr> { @@ -120,7 +120,7 @@ impl ApiModule<DuRsConf, DursMsg> for WS2Pv2Module { } } -impl NetworkModule<DuRsConf, DursMsg> for WS2Pv2Module { +impl NetworkModule<DuRsConf, DursMsg> for WS2PModule { fn sync( _soft_meta_datas: &SoftwareMetaDatas<DuRsConf>, _keys: RequiredKeysContent, @@ -140,7 +140,7 @@ impl NetworkModule<DuRsConf, DursMsg> for WS2Pv2Module { /// WS2P subcommand options pub struct WS2POpt {} -impl DursModule<DuRsConf, DursMsg> for WS2Pv2Module { +impl DursModule<DuRsConf, DursMsg> for WS2PModule { type ModuleUserConf = WS2PUserConf; type ModuleConf = WS2PConf; type ModuleOpt = WS2POpt; -- GitLab