Skip to content

Commit 77d62f3

Browse files
committed
f: Rename handle_message_received -> message_received
Since the function is called when any message from any handler is received, and is not dependent on any specific message, rename the function to be more generic and improve the documentation.
1 parent e16852b commit 77d62f3

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

lightning-net-tokio/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,7 @@ mod tests {
787787
fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
788788
Some(vec![ChainHash::using_genesis_block(Network::Testnet)])
789789
}
790-
fn handle_message_received(&self) {}
790+
fn message_received(&self) {}
791791
}
792792
impl MessageSendEventsProvider for MsgHandler {
793793
fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {

lightning/src/ln/channelmanager.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10747,7 +10747,7 @@ where
1074710747
msg.channel_id.clone())), *counterparty_node_id);
1074810748
}
1074910749

10750-
fn handle_message_received(&self) {
10750+
fn message_received(&self) {
1075110751
for (payment_id, retryable_invoice_request) in self
1075210752
.pending_outbound_payments
1075310753
.release_invoice_requests_awaiting_invoice()

lightning/src/ln/msgs.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1606,9 +1606,10 @@ pub trait ChannelMessageHandler : MessageSendEventsProvider {
16061606
/// connecting to peers.
16071607
fn get_chain_hashes(&self) -> Option<Vec<ChainHash>>;
16081608

1609-
/// Handles behavior which is triggered when any message from any peer for any handler
1610-
/// is received.
1611-
fn handle_message_received(&self);
1609+
/// Indicates that a message was received from any peer for any handler.
1610+
/// Called before the message is passed to the appropriate handler.
1611+
/// Useful for indicating that a network connection is active.
1612+
fn message_received(&self);
16121613
}
16131614

16141615
/// A trait to describe an object which can receive routing messages.

lightning/src/ln/peer_handler.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ impl ChannelMessageHandler for ErroringMessageHandler {
388388
ErroringMessageHandler::push_error(self, their_node_id, msg.channel_id);
389389
}
390390

391-
fn handle_message_received(&self) {}
391+
fn message_received(&self) {}
392392
}
393393

394394
impl Deref for ErroringMessageHandler {
@@ -1752,7 +1752,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
17521752
log_trace!(logger, "Received message {:?} from {}", message, log_pubkey!(their_node_id));
17531753
}
17541754

1755-
self.message_handler.chan_handler.handle_message_received();
1755+
self.message_handler.chan_handler.message_received();
17561756

17571757
let mut should_forward = None;
17581758

lightning/src/util/test_utils.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -937,7 +937,7 @@ impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
937937
self.received_msg(wire::Message::TxAbort(msg.clone()));
938938
}
939939

940-
fn handle_message_received(&self) {}
940+
fn message_received(&self) {}
941941
}
942942

943943
impl events::MessageSendEventsProvider for TestChannelMessageHandler {

0 commit comments

Comments
 (0)