pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-05-30 15:11:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a note about the deprecation of register_notifications_protocol (#6111)

Browse Source
This commit is contained in:
Pierre Krieger
2020-05-22 12:43:55 +02:00
committed by GitHub
parent efae379676
commit c6e23b615f
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/client/network/src/service.rs
+8 -4
View File
@@ -559,13 +559,17 @@ impl<B: BlockT + 'static, H: ExHashT> NetworkService<B, H> {
/// Registers a new notifications protocol. /// Registers a new notifications protocol.
/// ///
/// After that, you can call `write_notifications`. /// After a protocol has been registered, you can call `write_notifications`.
///
/// **Important**: This method is a work-around, and you are instead strongly encouraged to
/// pass the protocol in the `NetworkConfiguration::notifications_protocols` list instead.
/// If you have no other choice but to use this method, you are very strongly encouraged to
/// call it very early on. Any connection open will retain the protocols that were registered
/// then, and not any new one.
/// ///
/// Please call `event_stream` before registering a protocol, otherwise you may miss events /// Please call `event_stream` before registering a protocol, otherwise you may miss events
/// about the protocol that you have registered. /// about the protocol that you have registered.
/// // TODO: remove this method after https://github.com/paritytech/substrate/issues/4587
/// You are very strongly encouraged to call this method very early on. Any connection open
/// will retain the protocols that were registered then, and not any new one.
pub fn register_notifications_protocol( pub fn register_notifications_protocol(
&self, &self,
engine_id: ConsensusEngineId, engine_id: ConsensusEngineId,