remove redundant RouterMessage<M>

Author: Bobonium

CHANGELOG.md

@@ -3,6 +3,8 @@
  - added `LeastMessageRouter`
  - config now supports loading optional file `./config/tyra.toml` to overwrite config parameters
    - defaults < `./config/tyra.toml` < environment variables
+ - removed `RouterMessage<M>`
+   - routers now support any user-defined message per default through a generic implementation
 
 # 0.8.0
 

examples/benchmark_router_round_robin.rs

@@ -2,7 +2,7 @@ use std::error::Error;
 use std::process::exit;
 use std::time::{Duration, Instant};
 use tyra::prelude::*;
-use tyra::router::{AddActorMessage, RoundRobinRouterFactory, RouterMessage};
+use tyra::router::{AddActorMessage, RoundRobinRouterFactory};
 
 struct MessageA {}
 
@@ -195,7 +195,7 @@ fn main() {
     aggregator.send(Start {}).unwrap();
     for _i in 0..message_count {
         let msg = MessageA {};
-        router.send(RouterMessage::new(msg)).unwrap();
+        router.send(msg).unwrap();
     }
     let duration = start.elapsed();
     println!("It took {:?} to send {} messages", duration, message_count);

examples/benchmark_single_actor_process_after_send.rs

@@ -69,8 +69,6 @@ impl Handler<MessageA> for Benchmark {
 
 fn main() {
     let actor_config = TyraConfig::new().unwrap();
-    let test = actor_config.thread_pool.config.get("default").unwrap();
-    let test = test.threads_max;
     let actor_system = ActorSystem::new(actor_config);
 
     let message_count = 10000000;
@@ -86,8 +84,6 @@ fn main() {
         )
         .unwrap();
     println!("Actors have been created");
-    println!("TEST: {}", actor.get_address().system);
-    println!("TEST2: {}", test);
     let start = Instant::now();
 
     actor.sleep(Duration::from_secs(3)).unwrap();

src/actor/actor_wrapper.rs

@@ -2,7 +2,7 @@ use crate::actor::actor_address::ActorAddress;
 use crate::actor::actor_send_error::ActorSendError;
 use crate::actor::handler::Handler;
 use crate::actor::mailbox::Mailbox;
-use crate::message::actor_message::ActorMessage;
+use crate::message::actor_message::BaseActorMessage;
 use crate::message::actor_stop_message::ActorStopMessage;
 use crate::message::sleep_message::SleepMessage;
 use crate::prelude::Actor;
@@ -59,7 +59,7 @@ where
     pub fn send<M>(&self, msg: M) -> Result<(), ActorSendError>
     where
         A: Handler<M>,
-        M: ActorMessage + 'static,
+        M: BaseActorMessage + 'static,
     {
         if self.mailbox.is_stopped() {
             return Err(ActorSendError::AlreadyStoppedError);
@@ -82,7 +82,7 @@ where
     pub fn send_timeout<M>(&self, msg: M, timeout: Duration) -> Result<(), ActorSendError>
     where
         A: Handler<M>,
-        M: ActorMessage + 'static,
+        M: BaseActorMessage + 'static,
     {
         if self.mailbox.is_stopped() {
             return Err(ActorSendError::AlreadyStoppedError);
@@ -105,7 +105,7 @@ where
     pub fn send_after<M>(&self, msg: M, delay: Duration) -> Result<(), ActorSendError>
     where
         A: Handler<M> + 'static,
-        M: ActorMessage + 'static,
+        M: BaseActorMessage + 'static,
     {
         if self.mailbox.is_stopped() {
             return Err(ActorSendError::AlreadyStoppedError);

src/actor/executor.rs

@@ -6,7 +6,7 @@ use crate::actor::actor_wrapper::ActorWrapper;
 use crate::actor::context::ActorContext;
 use crate::actor::handler::Handler;
 use crate::actor::mailbox::Mailbox;
-use crate::message::actor_message::ActorMessage;
+use crate::message::actor_message::BaseActorMessage;
 use crate::message::envelope::{MessageEnvelope, MessageEnvelopeTrait};
 use crate::message::system_stop_message::SystemStopMessage;
 use crate::prelude::{Actor, ActorPanicSource, ActorResult};
@@ -251,7 +251,7 @@ where
     pub fn send<M>(&self, msg: M) -> Result<(), flume::SendTimeoutError<MessageEnvelope<A>>>
     where
         A: Handler<M>,
-        M: ActorMessage + 'static,
+        M: BaseActorMessage + 'static,
     {
         return self
             .mailbox

src/actor/handler.rs

@@ -1,6 +1,6 @@
 use crate::actor::actor::Actor;
 use crate::actor::context::ActorContext;
-use crate::message::actor_message::ActorMessage;
+use crate::message::actor_message::BaseActorMessage;
 use crate::message::actor_stop_message::ActorStopMessage;
 use crate::message::sleep_message::SleepMessage;
 use crate::message::system_stop_message::SystemStopMessage;
@@ -15,7 +15,7 @@ use std::error::Error;
 ///
 /// ```rust
 /// use std::error::Error;
-/// use tyra::prelude::{TyraConfig, ActorSystem, ActorFactory, ActorContext, SerializedMessage, ActorMessage, Handler, Actor, ActorResult};
+/// use tyra::prelude::{TyraConfig, ActorSystem, ActorFactory, ActorContext, SerializedMessage, Handler, Actor, ActorResult, ActorMessage};
 ///
 /// struct TestActor {}
 /// impl Actor for TestActor {}
@@ -32,7 +32,7 @@ use std::error::Error;
 pub trait Handler<M: ?Sized>
 where
     Self: Actor + Sized,
-    M: ActorMessage,
+    M: BaseActorMessage,
 {
     fn handle(
         &mut self,
@@ -71,7 +71,7 @@ impl<M, A> Handler<BulkActorMessage<M>> for A
 where
     Self: Actor + Sized,
     A: Handler<M>,
-    M: ActorMessage,
+    M: BaseActorMessage,
 {
     fn handle(
         &mut self,

src/actor/mailbox.rs

@@ -1,6 +1,6 @@
 use crate::actor::actor_send_error::ActorSendError;
 use crate::actor::handler::Handler;
-use crate::message::actor_message::ActorMessage;
+use crate::message::actor_message::BaseActorMessage;
 use crate::message::envelope::MessageEnvelope;
 use crate::prelude::{Actor, SerializedMessage};
 use std::any::Any;
@@ -58,7 +58,7 @@ where
     pub fn send<M>(&self, msg: M) -> Result<(), ActorSendError>
     where
         A: Handler<M>,
-        M: ActorMessage + 'static,
+        M: BaseActorMessage + 'static,
     {
         let result = self.msg_in.send(MessageEnvelope::new(msg));
         if result.is_ok() {
@@ -71,7 +71,7 @@ where
     pub fn send_timeout<M>(&self, msg: M, timeout: Duration) -> Result<(), ActorSendError>
     where
         A: Handler<M>,
-        M: ActorMessage + 'static,
+        M: BaseActorMessage + 'static,
     {
         let result = self.msg_in.send_timeout(MessageEnvelope::new(msg), timeout);
         if result.is_ok() {

src/config/tyra_config.rs

@@ -2,7 +2,7 @@ use std::path::Path;
 use crate::config::global_config::GeneralConfig;
 use crate::config::pool_config::PoolConfig;
 
-use config::{Config, ConfigError, Environment, File, FileFormat};
+use config::{Config, ConfigError, File, FileFormat};
 use serde::{Deserialize, Serialize};
 
 pub const DEFAULT_POOL: &str = "default";

src/message/actor_init_message.rs

@@ -1,4 +1,4 @@
-use crate::message::actor_message::ActorMessage;
+use crate::prelude::ActorMessage;
 
 /// Can be implemented by an Actor through Handler<ActorInitMessage> to be used to init an Actor
 pub struct ActorInitMessage {}
@@ -9,4 +9,5 @@ impl ActorInitMessage {
     }
 }
 
+/// intentionally implements `ActorMessage`, because it does NOT provide a generic `Handler<ActorInitMessage>` implementation
 impl ActorMessage for ActorInitMessage {}

src/message/actor_message.rs

@@ -1,3 +1,25 @@
+/// This trait is used internally by the `ActorSystem` and builds the base for all messaging
+/// It's automatically implemented by the `ActorMessage` trait that should be used
+///
+/// It is used by Messages defined in the system
+/// All messages that use this trait directly should also implement a dynamic `Handler<M>` that applies to any `Actor`
+pub trait BaseActorMessage: Send + Sync {
+}
+
+/// This trait is used by Messages defined by the system
+/// All messages that use this trait should also implement a dynamic `Handler<M>` that applies to any `Actor`
+pub trait DefaultActorMessage: Send + Sync {
+    /// returns the message id
+    fn get_id(&self) -> usize {
+        return 0;
+    }
+}
+
+impl<A> BaseActorMessage for A
+where
+    A: DefaultActorMessage
+{}
+
 /// Core trait to define Messages
 ///
 /// # Examples
@@ -16,3 +38,9 @@ pub trait ActorMessage: Send + Sync {
         return 0;
     }
 }
+
+/// this should be `BaseActorMessage` but it's currently not possible because of https://github.com/rust-lang/rust/issues/20400
+impl<A> DefaultActorMessage for A
+    where
+        A: ActorMessage
+{}