[−][src]Struct actix::prelude::Supervisor
Actor supervisor
Supervisor manages incoming message for actor. In case of actor failure,
supervisor creates new execution context and restarts actor lifecycle.
Supervisor does not re-create actor, it just calls restarting()
method.
Supervisor has same lifecycle as actor. In situation when all addresses to supervisor get dropped and actor does not execute anything, supervisor terminates.
Supervisor
can not guarantee that actor successfully process incoming
message. If actor fails during message processing, this message can not be
recovered. Sender would receive Err(Cancelled)
error in this situation.
Example
#[derive(Message)] #[rtype(result = "()")] struct Die; struct MyActor; impl Actor for MyActor { type Context = Context<Self>; } // To use actor with supervisor actor has to implement `Supervised` trait impl actix::Supervised for MyActor { fn restarting(&mut self, ctx: &mut Context<MyActor>) { println!("restarting"); } } impl Handler<Die> for MyActor { type Result = (); fn handle(&mut self, _: Die, ctx: &mut Context<MyActor>) { ctx.stop(); } } fn main() { System::run(|| { let addr = actix::Supervisor::start(|_| MyActor); addr.do_send(Die); }); }
Methods
impl<A> Supervisor<A> where
A: Supervised + Actor<Context = Context<A>>,
[src]
A: Supervised + Actor<Context = Context<A>>,
pub fn start<F>(f: F) -> Addr<A> where
F: FnOnce(&mut A::Context) -> A + 'static,
A: Actor<Context = Context<A>>,
[src]
F: FnOnce(&mut A::Context) -> A + 'static,
A: Actor<Context = Context<A>>,
Start new supervised actor in current tokio runtime.
Type of returned address depends on variable type. For example to get
Addr<Syn, _>
of newly created actor, use explicitly Addr<Syn, _>
type as type of a variable.
struct MyActor; impl Actor for MyActor { type Context = Context<Self>; } // Get `Addr` of a MyActor actor let addr = actix::Supervisor::start(|_| MyActor);
pub fn start_in_arbiter<F>(sys: &Arbiter, f: F) -> Addr<A> where
A: Actor<Context = Context<A>>,
F: FnOnce(&mut Context<A>) -> A + Send + 'static,
[src]
A: Actor<Context = Context<A>>,
F: FnOnce(&mut Context<A>) -> A + Send + 'static,
Start new supervised actor in arbiter's thread.
Trait Implementations
impl<A: Debug> Debug for Supervisor<A> where
A: Supervised + Actor<Context = Context<A>>,
[src]
A: Supervised + Actor<Context = Context<A>>,
impl<A> PinnedDrop for Supervisor<A> where
A: Supervised + Actor<Context = Context<A>>,
[src]
A: Supervised + Actor<Context = Context<A>>,
impl<'pin, A> Unpin for Supervisor<A> where
A: Supervised + Actor<Context = Context<A>>,
__Supervisor<'pin, A>: Unpin,
[src]
A: Supervised + Actor<Context = Context<A>>,
__Supervisor<'pin, A>: Unpin,
Auto Trait Implementations
impl<A> !RefUnwindSafe for Supervisor<A>
impl<A> !Send for Supervisor<A>
impl<A> !Sync for Supervisor<A>
impl<A> !UnwindSafe for Supervisor<A>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> FutureExt for T where
T: Future + ?Sized,
[src]
T: Future + ?Sized,
ⓘImportant traits for Map<Fut, F>fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
ⓘImportant traits for Then<Fut1, Fut2, F>fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
[src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
ⓘImportant traits for Either<A, B>fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
ⓘImportant traits for Either<A, B>fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
fn into_stream(self) -> IntoStream<Self>
[src]
ⓘImportant traits for Flatten<Fut>fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
[src]
Self::Output: Future,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
ⓘImportant traits for Fuse<Fut>fn fuse(self) -> Fuse<Self>
[src]
ⓘImportant traits for Inspect<Fut, F>fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
ⓘImportant traits for CatchUnwind<Fut>fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
ⓘImportant traits for Shared<Fut>fn shared(self) -> Shared<Self> where
Self::Output: Clone,
[src]
Self::Output: Clone,
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
[src]
ⓘImportant traits for Pin<P>fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send>> where
Self: Send + 'a,
[src]
Self: Send + 'a,
ⓘImportant traits for Pin<P>fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>> where
Self: 'a,
[src]
Self: 'a,
ⓘImportant traits for UnitError<Fut>fn unit_error(self) -> UnitError<Self>
[src]
ⓘImportant traits for NeverError<Fut>fn never_error(self) -> NeverError<Self>
[src]
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,
fn now_or_never(self) -> Option<Self::Output>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
fn vzip(self) -> V
impl<F, A> WrapFuture<A> for F where
A: Actor,
F: Future,
[src]
A: Actor,
F: Future,
type Future = FutureWrap<F, A>
The future that this type can be converted into.
type Output = <F as Future>::Output
The item that the future may resolve with.