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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
use std::sync::{Arc, Mutex};
use std::fmt;
use std::panic::{UnwindSafe, RefUnwindSafe};
use ::actor::{Actor, BoxActor};
/// Provides instances of `ActorProducer` for use when creating Actors (`actor_of`).
///
/// Actors are not created directly. Instead you provide an `ActorProducer`
/// that allows the `ActorSystem` to start an actor when `actor_of` is used,
/// or when an actor fails and a supervisor requests an actor to be restarted.
///
/// `ActorProducer` can hold values required by the actor's factory method
/// parameters.
pub struct Props;
impl Props {
/// Creates an `ActorProducer` with no factory method parameters.
///
/// # Examples
///
/// ```
/// # extern crate riker;
/// # extern crate riker_default;
///
/// # use riker::actors::*;
/// # use riker_default::DefaultModel;
///
/// struct User;
///
/// impl User {
/// fn actor() -> BoxActor<String> {
/// Box::new(User)
/// }
/// }
///
/// # impl Actor for User {
/// # type Msg = String;
/// # fn receive(&mut self, _ctx: &Context<String>, _msg: String, _sender: Option<ActorRef<String>>) {}
/// # }
/// // main
/// let model: DefaultModel<String> = DefaultModel::new();
/// let system = ActorSystem::new(&model).unwrap();
///
/// let props = Props::new(Box::new(User::actor));
///
/// // start the actor and get an `ActorRef`
/// let actor = system.actor_of(props, "user").unwrap();
/// ```
pub fn new<A>(creator: Box<Fn() -> A + Send>)
-> Arc<Mutex<Box<ActorProducer<Actor = A>>>>
where A: Actor + Send + 'static
{
Arc::new(Mutex::new(ActorProps::new(creator)))
}
/// Creates an `ActorProducer` with one or more factory method parameters.
///
/// # Examples
/// An actor requiring a single parameter.
/// ```
/// # extern crate riker;
/// # extern crate riker_default;
///
/// # use riker::actors::*;
/// # use riker_default::DefaultModel;
///
/// struct User {
/// name: String,
/// }
///
/// impl User {
/// fn actor(name: String) -> BoxActor<String> {
/// let actor = User {
/// name
/// };
///
/// Box::new(actor)
/// }
/// }
///
/// # impl Actor for User {
/// # type Msg = String;
/// # fn receive(&mut self, _ctx: &Context<String>, _msg: String, _sender: Option<ActorRef<String>>) {}
/// # }
/// // main
/// let model: DefaultModel<String> = DefaultModel::new();
/// let system = ActorSystem::new(&model).unwrap();
///
/// let props = Props::new_args(Box::new(User::actor), "Naomi Nagata".into());
///
/// let actor = system.actor_of(props, "user").unwrap();
/// ```
/// An actor requiring multiple parameters.
/// ```
/// # extern crate riker;
/// # extern crate riker_default;
///
/// # use riker::actors::*;
/// # use riker_default::DefaultModel;
///
/// struct BankAccount {
/// name: String,
/// number: String,
/// }
///
/// impl BankAccount {
/// fn actor((name, number): (String, String)) -> BoxActor<String> {
/// let actor = BankAccount {
/// name,
/// number
/// };
///
/// Box::new(actor)
/// }
/// }
///
/// # impl Actor for BankAccount {
/// # type Msg = String;
/// # fn receive(&mut self, _ctx: &Context<String>, _msg: String, _sender: Option<ActorRef<String>>) {}
/// # }
/// // main
/// let model: DefaultModel<String> = DefaultModel::new();
/// let system = ActorSystem::new(&model).unwrap();
///
/// let props = Props::new_args(Box::new(BankAccount::actor),
/// ("James Holden".into(), "12345678".into()));
///
/// // start the actor and get an `ActorRef`
/// let actor = system.actor_of(props, "bank_account").unwrap();
/// ```
pub fn new_args<A, Args>(creator: Box<Fn(Args) -> A + Send>, args: Args)
-> Arc<Mutex<Box<ActorProducer<Actor = A>>>>
where A: Actor + Send + 'static, Args: ActorArgs + 'static
{
Arc::new(Mutex::new(ActorPropsWithArgs::new(creator, args)))
}
}
/// A `Clone`, `Send` and `Sync` `ActorProducer`
pub type BoxActorProd<Msg> = Arc<Mutex<ActorProducer<Actor=BoxActor<Msg>>>>;
/// Represents the underlying Actor factory function for creating instances of `Actor`.
///
/// Actors are not created directly. Instead you provide an `ActorProducer`
/// that allows the `ActorSystem` to start an actor when `actor_of` is used,
/// or when an actor fails and a supervisor requests an actor to be restarted.
///
/// `ActorProducer` can hold values required by the actor's factory method
/// parameters.
pub trait ActorProducer : fmt::Debug + Send + UnwindSafe + RefUnwindSafe {
type Actor: Actor;
/// Produces an instance of an `Actor`.
///
/// The underlying factory method provided
/// in the original `Props::new(f: Fn() -> A + Send`) or
/// `Props::new(f: Fn(Args) -> A + Send>, args: Args)` is called.
///
/// Any parameters `Args` will be cloned and passed to the function.
///
/// # Panics
/// If the provided factory method panics the panic will be caught
/// by the system, resulting in an error result returning to `actor_of`.
fn produce(&self) -> Self::Actor;
}
impl<A> ActorProducer for Arc<Mutex<Box<ActorProducer<Actor = A>>>>
where A: Actor + Send + 'static
{
type Actor = A;
fn produce(&self) -> A {
self.lock().unwrap().produce()
}
}
impl<A> ActorProducer for Arc<Mutex<ActorProducer<Actor = A>>>
where A: Actor + Send + 'static
{
type Actor = A;
fn produce(&self) -> A {
self.lock().unwrap().produce()
}
}
impl<A> ActorProducer for Box<ActorProducer<Actor = A>>
where A: Actor + Send + 'static
{
type Actor = A;
fn produce(&self) -> A {
(**self).produce()
}
}
pub struct ActorProps<A: Actor> {
creator: Box<Fn() -> A + Send>,
}
impl<A: Actor> UnwindSafe for ActorProps<A> {}
impl<A: Actor> RefUnwindSafe for ActorProps<A> {}
impl<A> ActorProps<A>
where A: Actor + Send + 'static
{
pub fn new(creator: Box<Fn() -> A + Send>) -> Box<ActorProducer<Actor = A>> {
Box::new(ActorProps { creator: creator })
}
}
impl<A> ActorProducer for ActorProps<A>
where A: Actor + Send + 'static
{
type Actor = A;
fn produce(&self) -> A {
let ref f = self.creator;
f()
}
}
impl<A: Actor> fmt::Display for ActorProps<A> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "Props") //todo fix this
}
}
impl<A: Actor> fmt::Debug for ActorProps<A> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "Props") //todo fix this
}
}
pub struct ActorPropsWithArgs<A: Actor, Args: ActorArgs> {
creator: Box<Fn(Args) -> A + Send>,
args: Args,
}
impl<A: Actor, Args: ActorArgs> UnwindSafe for ActorPropsWithArgs<A, Args> {}
impl<A: Actor, Args: ActorArgs> RefUnwindSafe for ActorPropsWithArgs<A, Args> {}
impl<A, Args> ActorPropsWithArgs<A, Args>
where A: Actor + Send + 'static, Args: ActorArgs + 'static
{
pub fn new(creator: Box<Fn(Args) -> A + Send>, args: Args) -> Box<ActorProducer<Actor = A>> {
Box::new(ActorPropsWithArgs {
creator: creator,
args: args,
})
}
}
impl<A, Args> ActorProducer for ActorPropsWithArgs<A, Args>
where A: Actor + Send + 'static, Args: ActorArgs + 'static
{
type Actor = A;
fn produce(&self) -> A {
let ref f = self.creator;
let args = self.args.clone();
f(args)
}
}
impl<A: Actor, Args: ActorArgs> fmt::Display for ActorPropsWithArgs<A, Args> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "Props") //todo fix this
}
}
impl<A: Actor, Args: ActorArgs> fmt::Debug for ActorPropsWithArgs<A, Args> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "Props") //todo fix this
}
}
pub trait ActorArgs: Clone + Send + Sync {}
impl<T: Clone + Send + Sync> ActorArgs for T {}