Skip to content

Commit 7deaa2c

Browse files
lrubiorodlrubiorod
committed
refactor(data-structures): rename internal GetPeers to RequestPeers to avoid message collision
1 parent a9af56c commit 7deaa2c

File tree

6 files changed

+34
-36
lines changed

6 files changed

+34
-36
lines changed

‎core/src/actors/messages.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -359,9 +359,9 @@ impl Message for GetRandomPeer {
359359
}
360360

361361
/// Message to get all the peer addresses from the list
362-
pub struct GetPeers;
362+
pub struct RequestPeers;
363363

364-
impl Message for GetPeers {
364+
impl Message for RequestPeers {
365365
type Result = PeersSocketAddrsResult;
366366
}
367367

@@ -398,17 +398,17 @@ impl Message for RunConsensus {
398398
// MESSAGES FROM SESSION
399399
////////////////////////////////////////////////////////////////////////////////////////
400400

401-
/// Message to indicate that the session needs to send a SendGetPeers message through the network
401+
/// Message to indicate that the session needs to send a GetPeers message through the network
402402
#[derive(Debug)]
403-
pub struct SendGetPeers;
403+
pub struct GetPeers;
404404

405-
impl Message for SendGetPeers {
405+
impl Message for GetPeers {
406406
type Result = SessionUnitResult;
407407
}
408408

409-
impl fmt::Display for SendGetPeers {
409+
impl fmt::Display for GetPeers {
410410
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
411-
write!(f, "SendGetPeers")
411+
write!(f, "GetPeers")
412412
}
413413
}
414414

‎core/src/actors/peers_manager/handlers.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ use log::{debug, error, warn};
33

44
use super::PeersManager;
55
use crate::actors::messages::{
6-
AddPeers, GetPeers, GetRandomPeer, PeersSocketAddrResult, PeersSocketAddrsResult, RemovePeers,
6+
AddPeers, GetRandomPeer, PeersSocketAddrResult, PeersSocketAddrsResult, RemovePeers,
7+
RequestPeers,
78
};
89

910
/// Handler for AddPeers message
@@ -52,11 +53,11 @@ impl Handler<GetRandomPeer> for PeersManager {
5253
}
5354
}
5455

55-
/// Handler for GetPeers message
56-
impl Handler<GetPeers> for PeersManager {
56+
/// Handler for RequestPeers message
57+
impl Handler<RequestPeers> for PeersManager {
5758
type Result = PeersSocketAddrsResult;
5859

59-
fn handle(&mut self, _msg: GetPeers, _: &mut Context<Self>) -> Self::Result {
60+
fn handle(&mut self, _msg: RequestPeers, _: &mut Context<Self>) -> Self::Result {
6061
debug!("Get all peers");
6162
self.peers.get_all()
6263
}

‎core/src/actors/session/handlers.rs

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ use crate::actors::{
2828
messages::{
2929
AddNewBlock, AddPeers, AddTransaction, AnnounceItems, Consolidate,
3030
DiscardExistingInventoryEntries, GetBlocksEpochRange, GetHighestCheckpointBeacon, GetItem,
31-
GetPeers, InventoryExchange, PeerLastEpoch, RequestBlock, SendGetPeers, SendInventoryItem,
31+
GetPeers, InventoryExchange, PeerLastEpoch, RequestBlock, RequestPeers, SendInventoryItem,
3232
SessionUnitResult,
3333
},
3434
peers_manager::PeersManager,
@@ -91,8 +91,8 @@ impl StreamHandler<BytesMut, Error> for Session {
9191
////////////////////
9292
// PEER DISCOVERY //
9393
////////////////////
94-
// Handle SendGetPeers message
95-
(_, SessionStatus::Consolidated, Command::SendGetPeers(_)) => {
94+
// Handle GetPeers message
95+
(_, SessionStatus::Consolidated, Command::GetPeers(_)) => {
9696
peer_discovery_get_peers(self, ctx);
9797
}
9898
// Handle Peers message
@@ -193,17 +193,14 @@ impl StreamHandler<BytesMut, Error> for Session {
193193
}
194194
}
195195

196-
/// Handler for SendGetPeers message (sent by other actors)
197-
impl Handler<SendGetPeers> for Session {
196+
/// Handler for GetPeers message (sent by other actors)
197+
impl Handler<GetPeers> for Session {
198198
type Result = SessionUnitResult;
199199

200-
fn handle(&mut self, _msg: SendGetPeers, _: &mut Context<Self>) {
201-
debug!(
202-
"Sending SendGetPeers message to peer at {:?}",
203-
self.remote_addr
204-
);
200+
fn handle(&mut self, _msg: GetPeers, _: &mut Context<Self>) {
201+
debug!("Sending GetPeers message to peer at {:?}", self.remote_addr);
205202
// Create get peers message
206-
let get_peers_msg = WitnetMessage::build_send_get_peers(self.magic_number);
203+
let get_peers_msg = WitnetMessage::build_get_peers(self.magic_number);
207204
// Write get peers message in session
208205
self.send_message(get_peers_msg);
209206
}
@@ -357,9 +354,9 @@ fn peer_discovery_get_peers(session: &mut Session, ctx: &mut Context<Session>) {
357354

358355
// Start chain of actions
359356
peers_manager_addr
360-
// Send GetPeer message to PeersManager actor
357+
// Send RequestPeers message to PeersManager actor
361358
// This returns a Request Future, representing an asynchronous message sending process
362-
.send(GetPeers)
359+
.send(RequestPeers)
363360
// Convert a normal future into an ActorFuture
364361
.into_actor(session)
365362
// Process the response from PeersManager

‎core/src/actors/sessions_manager/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ use crate::actors::{
1414
chain_manager::ChainManager,
1515
connections_manager::ConnectionsManager,
1616
messages::{
17-
Anycast, Broadcast, GetRandomPeer, InventoryExchange, OutboundTcpConnect,
18-
PeersSocketAddrResult, SendGetPeers, SetNetworkReady,
17+
Anycast, Broadcast, GetPeers, GetRandomPeer, InventoryExchange, OutboundTcpConnect,
18+
PeersSocketAddrResult, SetNetworkReady,
1919
},
2020
peers_manager::PeersManager,
2121
session::Session,
@@ -104,15 +104,15 @@ impl SessionsManager {
104104
fn discovery_peers(&self, ctx: &mut Context<Self>, discovery_peers_period: Duration) {
105105
// Schedule the discovery_peers with a given period
106106
ctx.run_later(discovery_peers_period, move |act, ctx| {
107-
// Send Anycast(SendGetPeers) message
107+
// Send Anycast(GetPeers) message
108108
ctx.notify(Anycast {
109-
command: SendGetPeers {},
109+
command: GetPeers {},
110110
});
111111
act.discovery_peers(ctx, discovery_peers_period);
112112
});
113113
}
114114

115-
/// Method to process peers manager GetPeer response
115+
/// Method to process peers manager RequestPeer response
116116
fn process_get_peer_response(
117117
&mut self,
118118
response: Result<PeersSocketAddrResult, MailboxError>,

‎docs/architecture/managers/peers-manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ These are the messages supported by the peers manager handlers:
3737
| AddPeers | `address: SocketAddr` | `PeersResult<Vec<SocketAddr>>` | Add peers to list |
3838
| RemovePeers | `address: SocketAddr` | `PeersResult<Vec<SocketAddr>>` | Remove peers from list |
3939
| GetRandomPeer | `()` | `PeersResult<Option<SocketAddr>>` | Get random peer |
40-
| GetPeers | `()` | `PeersResult<Vec<SocketAddr>>` | Get all peers |
40+
| RequestPeers | `()` | `PeersResult<Vec<SocketAddr>>` | Get all peers |
4141

4242
The handling of these messages is basically just calling the corresponding methods from the
4343
[`Peers`][peers] library that is implemented by [`peers.rs`][peers].

‎docs/architecture/managers/sessions-manager.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,12 @@ successfully sent.
142142

143143
These are the messages sent by the sessions manager:
144144

145-
| Message | Destination | Input type | Output type | Description |
146-
| -------------------- | -------------------- | ------------ | --------------------------------- | ------------------------------------------------------------------------ |
147-
| `GetConfig` | `ConfigManager` | `()` | `Result<Config, io::Error>` | Request the configuration |
148-
| `GetRandomPeer` | `PeersManager` | `()` | `PeersResult<Option<SocketAddr>>` | Request the address of a peer |
149-
| `OutboundTcpConnect` | `ConnectionsManager` | `SocketAddr` | `()` | Request a TCP conn to an address |
150-
| `Anycast<GetPeers>` | `SessionsManager` | `()` | `()` | Request to forward a GetPeers message to one randomly selected `Session` |
145+
| Message | Destination | Input type | Output type | Description |
146+
| ------------------------ | -------------------- | ------------ | --------------------------------- | ---------------------------------------------------------------------------- |
147+
| `GetConfig` | `ConfigManager` | `()` | `Result<Config, io::Error>` | Request the configuration |
148+
| `GetRandomPeer` | `PeersManager` | `()` | `PeersResult<Option<SocketAddr>>` | Request the address of a peer |
149+
| `OutboundTcpConnect` | `ConnectionsManager` | `SocketAddr` | `()` | Request a TCP conn to an address |
150+
| `Anycast<GetPeers>` | `SessionsManager` | `()` | `()` | Request to forward a GetPeers message to one randomly selected `Session` |
151151

152152
#### GetConfig
153153

0 commit comments

Comments
 (0)