1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
use super::handler_id::HandlerId;
use super::registrar::WorkerRegistrar;
use super::scope::{WorkerDestroyHandle, WorkerScope};
use super::spawner::WorkerSpawner;
use crate::traits::{Registrable, Spawnable};
/// Declares the behaviour of a worker.
pub trait Worker: Sized {
/// Update message type.
type Message;
/// Incoming message type.
type Input;
/// Outgoing message type.
type Output;
/// Creates an instance of a worker.
fn create(scope: &WorkerScope<Self>) -> Self;
/// Receives an update.
///
/// This method is called when the worker send messages to itself via
/// [`WorkerScope::send_message`].
fn update(&mut self, scope: &WorkerScope<Self>, msg: Self::Message);
/// New bridge created.
///
/// When a new bridge is created by [`WorkerSpawner::spawn`](crate::WorkerSpawner)
/// or [`WorkerBridge::fork`](crate::WorkerBridge::fork),
/// the worker will be notified the [`HandlerId`] of the created bridge via this method.
fn connected(&mut self, scope: &WorkerScope<Self>, id: HandlerId) {
let _scope = scope;
let _id = id;
}
/// Receives an input from a connected bridge.
///
/// When a bridge sends an input via [`WorkerBridge::send`](crate::WorkerBridge::send), the
/// worker will receive the input via this method.
fn received(&mut self, scope: &WorkerScope<Self>, msg: Self::Input, id: HandlerId);
/// Existing bridge destroyed.
///
/// When a bridge is dropped, the worker will be notified with this method.
fn disconnected(&mut self, scope: &WorkerScope<Self>, id: HandlerId) {
let _scope = scope;
let _id = id;
}
/// Destroys the current worker.
///
/// When all bridges are dropped, the method will be invoked.
///
/// This method is provided a destroy handle where when it is dropped, the worker is closed.
/// If the worker is closed immediately, then it can ignore the destroy handle.
/// Otherwise hold the destroy handle until the clean up task is finished.
///
/// # Note
///
/// This method will only be called after all bridges are disconnected.
/// Attempting to send messages after this method is called will have no effect.
fn destroy(&mut self, scope: &WorkerScope<Self>, destruct: WorkerDestroyHandle<Self>) {
let _scope = scope;
let _destruct = destruct;
}
}
impl<W> Spawnable for W
where
W: Worker + 'static,
{
type Spawner = WorkerSpawner<Self>;
fn spawner() -> WorkerSpawner<Self> {
WorkerSpawner::new()
}
}
impl<W> Registrable for W
where
W: Worker + 'static,
{
type Registrar = WorkerRegistrar<Self>;
fn registrar() -> WorkerRegistrar<Self> {
WorkerRegistrar::new()
}
}