tyra 1.0.0

Typed Actor System
Documentation 
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

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::BaseActorMessage;
use crate::message::actor_stop_message::ActorStopMessage;
use crate::message::sleep_message::SleepMessage;
use crate::prelude::Actor;
use crate::system::internal_actor_manager::InternalActorManager;
use crate::system::wakeup_manager::WakeupManager;
use std::fmt::{Debug, Formatter};
use std::panic::UnwindSafe;
use std::time::Duration;

/// Wrapper used to interact with [Actor]
pub struct ActorWrapper<A>
where
    A: Actor,
{
    mailbox: Mailbox<A>,
    address: ActorAddress,
    wakeup_manager: WakeupManager,
    internal_actor_manager: Box<InternalActorManager>,
}

impl<A> Debug for ActorWrapper<A>
where
    A: Actor,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "")
    }
}

impl<A> UnwindSafe for ActorWrapper<A> where A: Actor {}

impl<A> ActorWrapper<A>
where
    A: Actor + UnwindSafe,
{
    /// Automatically called by the [ActorBuilder.build](../prelude/struct.ActorBuilder.html#method.build)
    pub fn new(
        mailbox: Mailbox<A>,
        address: ActorAddress,
        wakeup_manager: WakeupManager,
        internal_actor_manager: InternalActorManager,
    ) -> Self {
        Self {
            mailbox,
            address,
            wakeup_manager,
            internal_actor_manager: Box::new(internal_actor_manager),
        }
    }

    /// Sends a message to the actor that is then processed through the corresponding Handler<M> implementation
    /// Blocks until message has been sent, or fails if the target has been stopped
    /// It is NOT recommended to use this to send messages to Actors with a limited mailbox. Use send_timeout() or send_after() for these cases
    pub fn send<M>(&self, msg: M) -> Result<(), ActorSendError>
    where
        A: Handler<M>,
        M: BaseActorMessage + 'static,
    {
        if self.mailbox.is_stopped() {
            return Err(ActorSendError::AlreadyStoppedError);
        }

        let result = self.mailbox.send(msg);

        if result.is_err() {
            return result;
        }

        if self.mailbox.is_sleeping() {
            self.wakeup_manager.wakeup(self.address.clone());
        }

        return Ok(());
    }

    /// Same as send, but with a user defined timeout
    pub fn send_timeout<M>(&self, msg: M, timeout: Duration) -> Result<(), ActorSendError>
    where
        A: Handler<M>,
        M: BaseActorMessage + 'static,
    {
        if self.mailbox.is_stopped() {
            return Err(ActorSendError::AlreadyStoppedError);
        }

        let result = self.mailbox.send_timeout(msg, timeout);

        if result.is_err() {
            return result;
        }

        if self.mailbox.is_sleeping() {
            self.wakeup_manager.wakeup(self.address.clone());
        }

        return Ok(());
    }

    /// Sends a message to the actor after a specified delay
    pub fn send_after<M>(&self, msg: M, delay: Duration) -> Result<(), ActorSendError>
    where
        A: Handler<M> + 'static,
        M: BaseActorMessage + 'static,
    {
        if self.mailbox.is_stopped() {
            return Err(ActorSendError::AlreadyStoppedError);
        }

        self.internal_actor_manager
            .send_after(msg, self.clone(), delay);

        return Ok(());
    }

    /// Tells the actor to stop accepting message and to shutdown after all existing messages have been processed
    pub fn stop(&self) -> Result<(), ActorSendError> {
        return self.send(ActorStopMessage::new());
    }

    /// Tells the actor to sleep for the specified duration
    pub fn sleep(&self, duration: Duration) -> Result<(), ActorSendError> {
        return self.send(SleepMessage { duration });
    }

    /// Returns a reference to the address of the actor
    pub fn get_address(&self) -> &ActorAddress {
        &self.address
    }

    pub fn get_mailbox_size(&self) -> usize {
        return self.mailbox.len();
    }
}

impl<A> Clone for ActorWrapper<A>
where
    A: Actor + UnwindSafe,
{
    fn clone(&self) -> Self {
        Self {
            wakeup_manager: self.wakeup_manager.clone(),
            mailbox: self.mailbox.clone(),
            address: self.address.clone(),
            internal_actor_manager: self.internal_actor_manager.clone(),
        }
    }
}