minimal-example.rs 3.87 KB
Newer Older
Fedor Sakharov's avatar
Fedor Sakharov committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Copyright 2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.

//! Shows a basic usage of the `Overseer`:
//!   * Spawning subsystems and subsystem child jobs
//!   * Establishing message passing

use std::time::Duration;
use futures::{
23
	channel::oneshot,
24
	pending, pin_mut, select, stream,
Fedor Sakharov's avatar
Fedor Sakharov committed
25
26
27
28
29
	FutureExt, StreamExt,
};
use futures_timer::Delay;
use kv_log_macro as log;

asynchronous rob's avatar
asynchronous rob committed
30
use polkadot_primitives::v1::{BlockData, PoV};
31
use polkadot_overseer::{Overseer, AllSubsystems};
32

33
use polkadot_subsystem::{Subsystem, SubsystemContext, SpawnedSubsystem, FromOverseer};
34
use polkadot_subsystem::messages::{
35
	CandidateValidationMessage, CandidateBackingMessage, AllMessages,
Fedor Sakharov's avatar
Fedor Sakharov committed
36
37
38
39
40
};

struct Subsystem1;

impl Subsystem1 {
41
	async fn run(mut ctx: impl SubsystemContext<Message=CandidateBackingMessage>)  {
Fedor Sakharov's avatar
Fedor Sakharov committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
		loop {
			match ctx.try_recv().await {
				Ok(Some(msg)) => {
					if let FromOverseer::Communication { msg } = msg {
						log::info!("msg {:?}", msg);
					}
					continue;
				}
				Ok(None) => (),
				Err(_) => {
					log::info!("exiting");
					return;
				}
			}

			Delay::new(Duration::from_secs(1)).await;
58
59
			let (tx, _) = oneshot::channel();

60
			ctx.send_message(AllMessages::CandidateValidation(
asynchronous rob's avatar
asynchronous rob committed
61
				CandidateValidationMessage::ValidateFromChainState(
62
					Default::default(),
asynchronous rob's avatar
asynchronous rob committed
63
					PoV {
64
						block_data: BlockData(Vec::new()),
asynchronous rob's avatar
asynchronous rob committed
65
					}.into(),
66
67
					tx,
				)
Fedor Sakharov's avatar
Fedor Sakharov committed
68
69
70
71
72
			)).await.unwrap();
		}
	}
}

73
74
75
impl<C> Subsystem<C> for Subsystem1
	where C: SubsystemContext<Message=CandidateBackingMessage>
{
76
	fn start(self, ctx: C) -> SpawnedSubsystem {
77
		let future = Box::pin(async move {
Fedor Sakharov's avatar
Fedor Sakharov committed
78
			Self::run(ctx).await;
79
			Ok(())
80
81
82
83
84
85
		});

		SpawnedSubsystem {
			name: "subsystem-1",
			future,
		}
Fedor Sakharov's avatar
Fedor Sakharov committed
86
87
88
89
90
91
	}
}

struct Subsystem2;

impl Subsystem2 {
92
	async fn run(mut ctx: impl SubsystemContext<Message=CandidateValidationMessage>)  {
93
94
95
96
97
98
99
100
101
		ctx.spawn(
			"subsystem-2-job",
			Box::pin(async {
				loop {
					log::info!("Job tick");
					Delay::new(Duration::from_secs(1)).await;
				}
			}),
		).await.unwrap();
Fedor Sakharov's avatar
Fedor Sakharov committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

		loop {
			match ctx.try_recv().await {
				Ok(Some(msg)) => {
					log::info!("Subsystem2 received message {:?}", msg);
					continue;
				}
				Ok(None) => { pending!(); }
				Err(_) => {
					log::info!("exiting");
					return;
				},
			}
		}
	}
}

119
120
121
impl<C> Subsystem<C> for Subsystem2
	where C: SubsystemContext<Message=CandidateValidationMessage>
{
122
	fn start(self, ctx: C) -> SpawnedSubsystem {
123
		let future = Box::pin(async move {
Fedor Sakharov's avatar
Fedor Sakharov committed
124
			Self::run(ctx).await;
125
			Ok(())
126
127
128
129
130
131
		});

		SpawnedSubsystem {
			name: "subsystem-2",
			future,
		}
Fedor Sakharov's avatar
Fedor Sakharov committed
132
133
134
135
136
	}
}

fn main() {
	femme::with_level(femme::LevelFilter::Trace);
Bastian Köcher's avatar
Bastian Köcher committed
137
	let spawner = sp_core::testing::TaskExecutor::new();
Fedor Sakharov's avatar
Fedor Sakharov committed
138
139
140
141
142
	futures::executor::block_on(async {
		let timer_stream = stream::repeat(()).then(|_| async {
			Delay::new(Duration::from_secs(1)).await;
		});

143
144
145
		let all_subsystems = AllSubsystems::<()>::dummy()
			.replace_candidate_validation(Subsystem2)
			.replace_candidate_backing(Subsystem1);
Fedor Sakharov's avatar
Fedor Sakharov committed
146
		let (overseer, _handler) = Overseer::new(
147
			vec![],
148
			all_subsystems,
149
			None,
Fedor Sakharov's avatar
Fedor Sakharov committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
			spawner,
		).unwrap();
		let overseer_fut = overseer.run().fuse();
		let timer_stream = timer_stream;

		pin_mut!(timer_stream);
		pin_mut!(overseer_fut);

		loop {
			select! {
				_ = overseer_fut => break,
				_ = timer_stream.next() => {
					log::info!("tick");
				}
				complete => break,
			}
		}
	});
}