Struct Session 

pub struct Session { /* private fields */ }

An actor which manages the IPC connection to a remote endpoint.

Trait Implementations

impl Actor for Session

type Context = SessionContext

The execution context type for this actor.

type Error = SessionError

The error type returned by lifecycle hooks and message handlers.

async fn post_start( &mut self, ctx: &mut Self::Context, ) -> Result<(), SessionError>

Invoked after an actor is spawned into the tokio runtime. The actor should be in Starting state.

async fn post_stop( &mut self, _ctx: &mut Self::Context, ) -> Result<(), SessionError>

Invoked after an actor is stopped. The actor should be in Stopped state.

fn pre_start(&mut self, ctx: &mut Self::Context) -> Result<(), Self::Error>

Invoked before an actor is spawned into the tokio runtime. The actor should be in Unstarted state.

fn stopping( &mut self, ctx: &mut Self::Context, ) -> impl Future<Output = Result<Stopping, Self::Error>> + Send

Invoked when an actor is being stopped. The actor should be in Stopping state.

fn run<S>( self, label: S, ) -> Result<(Address<Self>, JoinHandle<()>), Self::Error>

where S: AsRef<str>,

Starts an actor and spawns it to the tokio runtime, returns its actor address and the join handle.

fn create<S, F>( label: S, f: F, ) -> Result<(Address<Self>, JoinHandle<()>), Self::Error>

where S: AsRef<str>, F: FnOnce(&mut Self::Context) -> Result<Self, Self::Error>,

Creates a new actor, starts it and spawns it to the tokio runtime, returns its actor address and the join handle.

fn create_in_span<S, F>( label: S, parent_span: Option<&Span>, f: F, ) -> Result<(Address<Self>, JoinHandle<()>), Self::Error>

where S: AsRef<str>, F: FnOnce(&mut Self::Context) -> Result<Self, Self::Error>,

Like create but allows the caller to specify the parent tracing span.

fn type_erased_recipient_fn() -> Option<fn(&Address<Self>) -> TypeErasedRecipient>

Available on crate feature type-erased-recipient-hook only.

Opt-in hook that turns an Address<A> into a type-erased trait object which can be downcast into a concrete Recipient<M>, where M is a specific message type chosen in the overridden implementation of this method.

impl Handler<CreateRemoteActor> for Session

type Result = FutureMessageResult<CreateRemoteActor>

The return type of the handler, which must implement MessageResponse.

async fn handle( &mut self, msg: CreateRemoteActor, _ctx: &mut <Self as Actor>::Context, ) -> Self::Result

Handles a message.

impl Handler<GetRemoteActor> for Session

type Result = FutureMessageResult<GetRemoteActor>

The return type of the handler, which must implement MessageResponse.

async fn handle( &mut self, msg: GetRemoteActor, _ctx: &mut <Self as Actor>::Context, ) -> Self::Result

Handles a message.

impl Handler<RemoteMessage> for Session

type Result = ()

The return type of the handler, which must implement MessageResponse.

async fn handle( &mut self, msg: RemoteMessage, _ctx: &mut <Self as Actor>::Context, ) -> Self::Result

Handles a message.