Struct actix::Supervisor [−][src]
Actor supervisor
A Supervisor manages incoming messages for an actor. In case of actor failure,
the supervisor creates a new execution context and restarts the actor’s lifecycle.
A Supervisor does not re-create their actor, it just calls the restarting()
method.
Supervisors have the same lifecycle as actors. If all addresses to a supervisor gets dropped and its actor does not execute anything, the supervisor terminates.
Supervisors can not guarantee that their actors successfully processes incoming
messages. If the actor fails during message processing, the message can not be
recovered. The sender would receive an Err(Cancelled)
error in this situation.
Examples
#[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() { let mut sys = System::new(); let addr = sys.block_on(async { actix::Supervisor::start(|_| MyActor) }); addr.do_send(Die); sys.run(); }
Implementations
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: &ArbiterHandle, 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,
A: Actor<Context = Context<A>>,
[src]
A: Supervised,
A: Actor<Context = Context<A>>,
impl<'__pin, A> Unpin for Supervisor<A> where
__Origin<'__pin, A>: Unpin,
A: Supervised,
A: Actor<Context = Context<A>>,
[src]
__Origin<'__pin, A>: Unpin,
A: Supervised,
A: Actor<Context = Context<A>>,
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,
pub fn 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,
pub fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
[src]
Self::Output: Into<U>,
pub 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,
pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>
[src]
pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
[src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>
[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
pub fn unit_error(self) -> UnitError<Self>
[src]
pub fn never_error(self) -> NeverError<Self>
[src]
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,
pub 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<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
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.
pub 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.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<F, A> WrapFuture<A> for F where
F: Future,
A: Actor,
[src]
F: Future,
A: Actor,
type Future = FutureWrap<F, A>
The future that this type can be converted into.