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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
//!
#![doc = include_str!("../README.md")]
//!
use std::collections::HashMap;
use std::fmt::Debug;
use std::sync::{Arc};
use tokio::sync::{mpsc, oneshot};
use futures::lock::{Mutex};
use async_trait::async_trait;
use tokio::sync::oneshot::Sender;
/// The `ActorRef` struct represents a reference to an actor in the Actorlib framework.
/// It contains the following fields:
///
/// - `tx`: A `Mutex` wrapping an `Option` that contains a sender part of a message passing channel.
/// This is used to send messages to the actor's task.
///
/// - `join_handle`: A `Mutex` wrapping an `Option` that contains a handle to the actor's task.
/// This is used to control the execution of the actor's task.
///
/// - `state`: An `Option` that contains the current state of the actor, wrapped in an `Arc<Mutex>` for thread safety.
///
/// - `self_ref`: A `Mutex` wrapping an `Option` that contains a reference to the actor itself.
/// This is useful for actors that need to send messages to themselves.
///
/// - `message_id`: A `Mutex` wrapping an integer that represents the ID of the last message sent to the actor.
///
/// - `promise`: A `Mutex` wrapping a `HashMap` that maps message IDs to one-shot channel senders.
/// This is used to send responses back to the sender of a message.
///
/// - `name`: A `String` that represents the name of the actor.
///
/// - `actor`: An `Arc` that contains the actor.
///
/// - `running`: A `Mutex` wrapping a boolean that indicates whether the actor is currently running or not.
///
/// # Type parameters
/// - `Actor`: The type of the actor.
/// - `Message`: The type of the messages that the actor can process.
/// - `State`: The type of the state of the actor.
/// - `Response`: The type of the response that the actor produces after processing a message.
/// - `Error`: The type of the error that the actor can produce.
#[derive(Debug)]
pub struct ActorRef<Actor, Message, State, Response, Error> {
tx: Mutex<Option<mpsc::Sender<(Message, i32)>>>,
join_handle: Mutex<Option<tokio::task::JoinHandle<()>>>,
state: Option<Arc<Mutex<State>>>,
self_ref: Mutex<Option<Arc<ActorRef<Actor, Message, State, Response, Error>>>>,
message_id: Mutex<i32>,
promise: Mutex<HashMap<i32, Sender<Result<Response, Error>>>>,
name: String,
actor: Arc<Actor>,
running: Mutex<bool>,
}
/// `Context` is a structure that holds the context of an actor.
///
/// It contains the following fields:
/// - `mgs`: The message that the actor is currently processing.
/// - `state`: The current state of the actor, wrapped in an `Arc<Mutex<T>>` for thread safety.
/// - `self_ref`: A reference to the actor itself. This is useful for actors that need to send messages to themselves.
///
/// # Type parameters
/// - `Actor`: The type of the actor.
/// - `Message`: The type of the messages that the actor can process.
/// - `State`: The type of the state of the actor.
/// - `Response`: The type of the response that the actor produces after processing a message.
/// - `Error`: The type of the error that the actor can produce.
#[derive(Debug)]
pub struct Context<Actor, Message, State, Response, Error> {
pub mgs: Message,
pub state: Arc<Mutex<State>>,
pub self_ref: Arc<ActorRef<Actor, Message, State, Response, Error>>,
}
/// `Handler` is a trait that defines the behavior of an actor in the Actorlib framework.
///
/// This trait is implemented by any type that can act as an actor in the Actorlib framework.
/// It provides methods for handling messages and managing the actor's lifecycle.
///
/// # Type parameters
/// - `Actor`: The type of the actor. This type must be `Sync`, `Send` and `'static`.
/// - `Message`: The type of the messages that the actor can process. This type must be `Sync`, `Send` and `'static`.
/// - `State`: The type of the state of the actor. This type must be `Sync`, `Send` and `'static`.
/// - `Response`: The type of the response that the actor produces after processing a message. This type must be `Sync`, `Send` and `'static`.
/// - `Error`: The type of the error that the actor can produce. This type must be `Sync`, `Send` and `'static`.
///
/// # Methods
/// - `receive`: This method is called when the actor receives a message. It takes a context, which contains the message and the state of the actor, and returns a `Future` that resolves to a `Result` containing either the response produced by the actor after processing the message, or an error.
/// - `pre_start`: This method is called before the actor starts. It takes the state of the actor and a reference to the actor itself, and returns a `Future` that resolves to a `Result`. If the `Result` is `Ok`, the actor starts; if it is `Err`, the actor does not start. By default, this method returns `Ok(())`.
/// - `pre_stop`: This method is called before the actor stops. It takes the state of the actor and a reference to the actor itself, and returns a `Future` that resolves to a `Result`. If the `Result` is `Ok`, the actor stops; if it is `Err`, the actor does not stop. By default, this method returns `Ok(())`.
#[async_trait]
pub trait Handler<Actor: Sync + Send + 'static, Message: Sync + Send + 'static, State: Sync + Send + 'static, Response: Sync + Send + 'static, Error: Sync + Send + 'static> {
async fn receive(&self, ctx: Arc<Context<Actor, Message, State, Response, Error>>) -> Result<Response, Error>;
async fn pre_start(&self, _state: Arc<Mutex<State>>, _self_ref: Arc<ActorRef<Actor, Message, State, Response, Error>>) -> Result<(), Error> {
Ok(())
}
async fn pre_stop(&self, _state: Arc<Mutex<State>>, _self_ref: Arc<ActorRef<Actor, Message, State, Response, Error>>) -> Result<(), Error> {
Ok(())
}
}
impl<Actor: Handler<Actor, Message, State, Response, Error> + Debug + Send + Sync + 'static, Message: Debug + Send + Sync + 'static, State: Debug + Send + Sync + 'static,
Response: Debug + Send + Sync + 'static, Error: std::error::Error + Debug + Send + Sync + From<std::io::Error> + 'static> ActorRef<Actor, Message, State, Response, Error> {
/// Creates a new `ActorRef` instance.
///
/// This function takes the following parameters:
/// - `name`: A `String` that represents the name of the actor.
/// - `actor`: An instance of the actor.
/// - `state`: The initial state of the actor.
/// - `buffer`: The size of the message buffer.
///
/// The function returns a `Result` that contains an `Arc` to the `ActorRef` instance in case of success,
/// or an `Error` in case of failure.
///
/// The function performs the following steps:
/// 1. Wraps the initial state in an `Arc<Mutex>`.
/// 2. Creates a new message passing channel with the specified buffer size.
/// 3. Creates a new `ActorRef` instance and wraps it in an `Arc`.
/// 4. Spawns a new asynchronous task that listens for incoming messages and processes them.
/// 5. Calls the `pre_start` method of the actor.
/// 6. Sets the `running` flag of the `ActorRef` to `true`.
/// 7. Returns the `Arc` to the `ActorRef` instance.
///
/// # Type parameters
/// - `Actor`: The type of the actor. This type must implement the `Handler` trait and be `Sync`, `Send`, and `'static`.
/// - `Message`: The type of the messages that the actor can process. This type must be `Debug`, `Send`, and `Sync`.
/// - `State`: The type of the state of the actor. This type must be `Debug`, `Send`, and `Sync`.
/// - `Response`: The type of the response that the actor produces after processing a message. This type must be `Debug`, `Send`, and `Sync`.
/// - `Error`: The type of the error that the actor can produce. This type must implement the `std::error::Error` trait and be `Debug`, `Send`, `Sync`, and `From<std::io::Error>`.
pub async fn new(name: String, actor: Actor, state: State, buffer: usize) -> Result<Arc<Self>, Error>
{
let state_arc = Arc::new(Mutex::new(state));
let state_clone = state_arc.clone();
let (tx, mut rx) = mpsc::channel(buffer);
let actor_arc= Arc::new(actor);
let actor = actor_arc.clone();
let actor_ref = ActorRef {
tx: Mutex::new(Some(tx)),
join_handle: Mutex::new(None),
state: Some(state_clone),
self_ref: Mutex::new(None),
message_id: Mutex::new(0),
promise: Mutex::new(HashMap::new()),
name: name,
actor: actor_arc.clone(),
running: Mutex::new(false),
};
let ret = Arc::new(actor_ref);
let ret_clone = ret.clone();
let ret_clone2 = ret.clone();
let ret_clone3 = ret.clone();
*ret.self_ref.lock().await = Some(ret.clone());
let join_handle = tokio::spawn(async move {
let me = ret_clone2.clone();
loop {
tokio::select! {
_ = futures::future::pending::<()>() => {
},
msg_opt = rx.recv() => {
match msg_opt {
None => {
log::debug!("<{}> No message", me.name);
break;
}
Some(message) => {
if *ret_clone3.running.lock().await == false {
return ();
}
let msg = message.0;
let message_id = message.1;
let state_clone = state_arc.clone();
log::debug!("<{}> Got message: {:?} Current state: {:?}", me.name, msg, state_clone.lock().await);
let msg_debug = format!("{:?}", msg);
let state = state_arc.clone();
let context = Context {
mgs: msg,
state: state,
self_ref: me.clone(),
};
let r = actor.receive(Arc::new(context));
{
let result = r.await;
log::trace!("<{}> Work result: {:?}", me.name, result);
if result.is_err() {
log::error!("<{}> Work error: {:?} on message {}", me.name, result, msg_debug);
}
let promise = ret_clone3.promise.lock().await.remove(&message_id);
match promise {
None => {
log::trace!("<{}> No promise for message_id: {}", me.name, message_id);
}
Some(promise) => {
log::trace!("<{}> Promise result: {:?}", me.name, result);
let _ = promise.send(result);
}
}
}
let state_clone = state_arc.clone();
log::trace!("<{}> After work on message new state: {:?}", me.name, state_clone.lock().await);
}
};
}
}
}
});
*ret.join_handle.lock().await = Some(join_handle);
let _ = actor_arc.pre_start(ret_clone.state.clone().unwrap(), ret_clone.clone()).await?;
*ret.running.lock().await = true;
log::info!("<{}> Actor started", ret_clone.name);
Ok(ret_clone)
}
/// Sends a message to the actor and waits for a response.
///
/// This method is part of the `ActorRef` struct and is used to send a message to the actor
/// and wait for a response. This is done by sending the message and a unique message ID
/// through a channel to the actor's task, which processes the message and sends the response
/// back through a one-shot channel.
///
/// The method locks the `tx` field of the `ActorRef` struct, which is an `Option` containing
/// a sender part of a message passing channel. If the `tx` field is `None`, the method returns
/// an error. Otherwise, it creates a new one-shot channel for the response, increments the
/// message ID, inserts the sender part of the one-shot channel into the `promise` field of the
/// `ActorRef` struct (which is a `HashMap` mapping message IDs to one-shot channel senders),
/// and sends the message and the message ID through the `tx` channel.
///
/// After sending the message, the method awaits the receiver part of the one-shot channel.
/// If the receiver receives a response, the method returns the response. If the receiver
/// is closed without sending a response, the method returns an error.
///
/// # Parameters
/// - `mgs`: The message to send to the actor.
///
/// # Returns
/// - `Result<Response, Error>`: The response from the actor, or an error if the actor failed
/// to process the message or if the `tx` field is `None`.
pub async fn ask(&self, mgs: Message) -> Result<Response, Error>
{
log::debug!("<{}> Result message: {:?}", self.name, mgs);
let tx_lock = self.tx.lock().await;
let tx = tx_lock.as_ref();
match tx {
None => {
return Err(std::io::Error::new(std::io::ErrorKind::Other, "Err").into());
}
Some(tx) => {
let (sender, receiver) = oneshot::channel();
{
*self.message_id.lock().await += 1;
self.promise.lock().await.insert(*self.message_id.lock().await, sender);
let r = tx.send((mgs, *self.message_id.lock().await)).await;
if r.is_err() {
return Err(std::io::Error::new(std::io::ErrorKind::Other, "Err").into());
}
}
let r = receiver.await;
match r {
Ok(res) => { res }
Err(_) => {
return Err(std::io::Error::new(std::io::ErrorKind::Other, "Err").into());
}
}
}
}
}
/// Sends a message to the actor without waiting for a response.
///
/// This method is part of the `ActorRef` struct and is used to send a message to the actor
/// without waiting for a response. This is done by sending the message and a zero message ID
/// through a channel to the actor's task, which processes the message.
///
/// The method locks the `tx` field of the `ActorRef` struct, which is an `Option` containing
/// a sender part of a message passing channel. If the `tx` field is `None`, the method returns
/// an error. Otherwise, it sends the message and a zero message ID through the `tx` channel.
///
/// After sending the message, the method returns `Ok(())` if the message was sent successfully,
/// or an error if the message could not be sent.
///
/// # Parameters
/// - `msg`: The message to send to the actor.
///
/// # Returns
/// - `Result<(), std::io::Error>`: `Ok(())` if the message was sent successfully, or an error
/// if the message could not be sent or if the `tx` field is `None`.
pub async fn send(&self, msg: Message) -> Result<(), std::io::Error> {
log::debug!("<{}> Push message: {:?}", self.name, msg);
let tx_lock = self.tx.lock().await;
let tx = tx_lock.as_ref();
match tx {
None => {
return Err(std::io::Error::new(std::io::ErrorKind::Other, "Err").into());
}
Some(tx) => {
let r = tx.send((msg, 0)).await;
if r.is_err() {
return Err(std::io::Error::new(std::io::ErrorKind::Other, "Err").into());
}
// let r = tx.try_send((msg, 0));
// match r {
// Ok(_) => {}
// Err(err) => {
// let err_str = format!("{:?}", err);
// return Err(std::io::Error::new(std::io::ErrorKind::Other, err_str).into());
// }
// }
}
}
Ok(())
}
/// Retrieves the current state of the actor.
///
/// This method is part of the `ActorRef` struct and is used to retrieve the current state of the actor.
/// The state is stored in the `state` field of the `ActorRef` struct, which is an `Option` containing
/// the state wrapped in an `Arc<Mutex>`.
///
/// The method clones the `state` field and logs a trace message containing the name of the actor and the state.
/// If the `state` field is `None`, the method returns an error. Otherwise, it returns the state.
///
/// # Returns
/// - `Result<Arc<Mutex<State>>, std::io::Error>`: The current state of the actor wrapped in an `Arc<Mutex>`,
/// or an error if the `state` field is `None`.
pub async fn state(&self) -> Result<Arc<Mutex<State>>, std::io::Error> {
let state_opt = self.state.clone();
log::trace!("<{}> State: {:?}", self.name, state_opt);
match state_opt {
None => {
return Err(std::io::Error::new(std::io::ErrorKind::Other, "No state").into());
}
Some(state) => {
Ok(state)
}
}
}
/// Stops the actor.
///
/// This method is part of the `ActorRef` struct and is used to stop the actor's execution.
///
/// The method performs the following steps:
/// 1. Checks if the actor is already stopped. If it is, the method returns `Ok(())`.
/// 2. Calls the `pre_stop` method of the actor.
/// 3. Sets the `running` flag of the `ActorRef` to `false`.
/// 4. Clears the `tx` and `self_ref` fields of the `ActorRef`.
/// 5. Aborts the actor's task if it is running.
/// 6. Clears the `join_handle` field of the `ActorRef`.
/// 7. Logs a debug message indicating that the actor has stopped.
///
/// # Returns
/// - `Result<(), Error>`: `Ok(())` if the actor was stopped successfully, or an `Error` if the `pre_stop` method of the actor returned an error.
pub async fn stop(&self) -> Result<(), Error> {
if *self.running.lock().await == false {
return Ok(());
}
let self_ref = self.self_ref.lock().await.clone().unwrap();
let _ = self.actor.pre_stop(self.state.clone().unwrap(), self_ref).await?;
*self.running.lock().await = false;
*self.tx.lock().await = None;
*self.self_ref.lock().await = None;
let join_handle = self.join_handle.lock().await.take();
match join_handle {
None => {}
Some(join_handle) => {
let _ = join_handle.abort();
log::debug!("join_handle abort()");
}
}
*self.join_handle.lock().await = None;
log::debug!("<{}> Stop worker", self.name);
Ok(())
}
}