Struct actix::WeakAddr

pub struct WeakAddr<A: Actor> { /* private fields */ }

A weakly referenced counterpart to Addr<A>.

Implementations

impl<A: Actor> WeakAddr<A>

pub fn upgrade(&self) -> Option<Addr<A>>

Attempts to upgrade the WeakAddr<A> pointer to an Addr<A>.

Returns None if the actor has since been dropped or the underlying address is disconnected.

Examples found in repository

examples/weak_addr.rs (line 28)

    fn send_tick(&mut self, _ctx: &mut Context<Self>) {
        for client in self.clients.iter() {
            if let Some(client) = client.upgrade() {
                client.do_send(TimePing(Instant::now()));
                println!("⏰ sent ping to client {:?}", client);
            } else {
                println!("⏰ client can no longer be upgraded");
            }
        }

        // gc
        self.clients = self
            .clients
            .drain(..)
            .filter(|c| c.upgrade().is_some())
            .collect();
        println!("⏰ service has {} clients", self.clients.len());
    }

pub fn recipient<M>(self) -> WeakRecipient<M>

where A: Handler<M>, A::Context: ToEnvelope<A, M>, M: Message + Send + 'static, M::Result: Send,

Examples found in repository

examples/weak_recipient.rs (line 89)

    fn started(&mut self, ctx: &mut Self::Context) {
        println!("🐰 starting ClientA");
        TimeService::from_registry()
            .send(RegisterForTime(ctx.address().downgrade().recipient()))
            .into_actor(self)
            .then(|_, _slf, _| fut::ready(()))
            .spawn(ctx);
    }

    fn stopping(&mut self, _ctx: &mut Self::Context) -> Running {
        println!("🐰 stopping ClientA");
        Running::Stop
    }

    fn stopped(&mut self, _ctx: &mut Self::Context) {
        println!("🐰 stopped ClientA");
    }
}

impl Handler<TimePing> for ClientA {
    type Result = ();

    fn handle(&mut self, msg: TimePing, _ctx: &mut Self::Context) -> Self::Result {
        println!("🐰 ClientA received ping: {:?}", msg.0);
    }
}

#[derive(Debug, Default)]
pub struct ClientB;

impl Actor for ClientB {
    type Context = Context<Self>;

    fn started(&mut self, ctx: &mut Self::Context) {
        println!("🐇 starting ClientB");
        TimeService::from_registry()
            .send(RegisterForTime(ctx.address().downgrade().recipient()))
            .into_actor(self)
            .then(|_, _slf, _| fut::ready(()))
            .spawn(ctx);
    }

Trait Implementations

impl<A: Actor> Clone for WeakAddr<A>

fn clone(&self) -> WeakAddr<A>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A: Actor> Debug for WeakAddr<A>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<A, M: Message + Send + 'static> From<WeakAddr<A>> for WeakRecipient<M>

where A: Handler<M> + Actor, M::Result: Send, A::Context: ToEnvelope<A, M>,

fn from(addr: WeakAddr<A>) -> WeakRecipient<M>

Converts to this type from the input type.

impl<A: Actor> PartialEq for WeakAddr<A>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: Actor> Eq for WeakAddr<A>