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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
#![allow(unused_variables)] use crate::{ actor::{ actor_cell::Context, actor_ref::{BasicActorRef, Sender}, }, system::SystemMsg, Message, }; pub trait Actor: Send + 'static { type Msg: Message; /// Invoked when an actor is being started by the system. /// /// Any initialization inherent to the actor's role should be /// performed here. /// /// Panics in `pre_start` do not invoke the /// supervision strategy and the actor will be terminated. fn pre_start(&mut self, ctx: &Context<Self::Msg>) {} /// Invoked after an actor has started. /// /// Any post initialization can be performed here, such as writing /// to a log file, emmitting metrics. /// /// Panics in `post_start` follow the supervision strategy. fn post_start(&mut self, ctx: &Context<Self::Msg>) {} /// Invoked after an actor has been stopped. fn post_stop(&mut self) {} /// Return a supervisor strategy that will be used when handling failed child actors. fn supervisor_strategy(&self) -> Strategy { Strategy::Restart } /// Invoked when an actor receives a system message /// /// It is guaranteed that only one message in the actor's mailbox is processed /// at any one time, including `recv` and `sys_recv`. fn sys_recv(&mut self, ctx: &Context<Self::Msg>, msg: SystemMsg, sender: Sender) {} /// Invoked when an actor receives a message /// /// It is guaranteed that only one message in the actor's mailbox is processed /// at any one time, including `recv` and `sys_recv`. fn recv(&mut self, ctx: &Context<Self::Msg>, msg: Self::Msg, sender: Sender); } impl<A: Actor + ?Sized> Actor for Box<A> { type Msg = A::Msg; fn pre_start(&mut self, ctx: &Context<Self::Msg>) { (**self).pre_start(ctx); } fn post_start(&mut self, ctx: &Context<Self::Msg>) { (**self).post_start(ctx) } fn post_stop(&mut self) { (**self).post_stop() } fn sys_recv( &mut self, ctx: &Context<Self::Msg>, msg: SystemMsg, sender: Option<BasicActorRef>, ) { (**self).sys_recv(ctx, msg, sender) } fn supervisor_strategy(&self) -> Strategy { (**self).supervisor_strategy() } fn recv(&mut self, ctx: &Context<Self::Msg>, msg: Self::Msg, sender: Option<BasicActorRef>) { (**self).recv(ctx, msg, sender) } } /// Receive and handle a specific message type /// /// This trait is typically used in conjuction with the #[actor] /// attribute macro and implemented for each message type to receive. /// /// # Examples /// /// ``` /// # use riker::actors::*; /// /// #[derive(Clone, Debug)] /// struct Foo; /// #[derive(Clone, Debug)] /// struct Bar; /// #[actor(Foo, Bar)] // <-- set our actor to receive Foo and Bar types /// struct MyActor; /// /// impl Actor for MyActor { /// type Msg = MyActorMsg; // <-- MyActorMsg is provided for us /// /// fn recv(&mut self, /// ctx: &Context<Self::Msg>, /// msg: Self::Msg, /// sender: Sender) { /// self.receive(ctx, msg, sender); // <-- call the respective implementation /// } /// } /// /// impl MyActor { /// fn actor() -> Self { /// MyActor /// } /// /// fn props() -> BoxActorProd<MyActor> { /// Props::new(MyActor::actor) /// } /// } /// /// impl Receive<Foo> for MyActor { /// type Msg = MyActorMsg; /// /// fn receive(&mut self, /// ctx: &Context<Self::Msg>, /// msg: Foo, // <-- receive Foo /// sender: Sender) { /// println!("Received a Foo"); /// } /// } /// /// impl Receive<Bar> for MyActor { /// type Msg = MyActorMsg; /// /// fn receive(&mut self, /// ctx: &Context<Self::Msg>, /// msg: Bar, // <-- receive Bar /// sender: Sender) { /// println!("Received a Bar"); /// } /// } /// /// // main /// let sys = ActorSystem::new().unwrap(); /// let actor = sys.actor_of(MyActor::props(), "my-actor").unwrap(); /// /// actor.tell(Foo, None); /// actor.tell(Bar, None); /// ``` pub trait Receive<Msg: Message> { type Msg: Message; /// Invoked when an actor receives a message /// /// It is guaranteed that only one message in the actor's mailbox is processed /// at any one time, including `receive`, `other_receive` and `system_receive`. fn receive(&mut self, ctx: &Context<Self::Msg>, msg: Msg, sender: Option<BasicActorRef>); } /// The actor trait object pub type BoxActor<Msg> = Box<dyn Actor<Msg = Msg> + Send>; /// Supervision strategy /// /// Returned in `Actor.supervision_strategy` pub enum Strategy { /// Stop the child actor Stop, /// Attempt to restart the child actor Restart, /// Escalate the failure to a parent Escalate, }