Struct fluxion::Fluxion

pub struct Fluxion<C: FluxionParams> { /* private fields */ }

Fluxion

The core management functionality of fluxion. Handles the creation, shutdown, and management of actors.

Used Arc internally, so this can be cloned around, although it is not recommended. Immutable references can be used to do most things instead.

Implementations

impl<C: FluxionParams> Fluxion<C>

pub fn new(id: &str) -> Self

Creates a new Fluxion instance

pub fn outbound_foreign(&self) -> Channel<ForeignMessage>

Gets the outbound foreign channel

pub fn get_id(&self) -> &str

Gets the system’s id

Returns

Returns the local system’s id.

pub async fn shutdown(&self) -> usize

Shutdown and remove all local actors.

Returns

Returns the number of actors shutdown

pub async fn relay_foreign( &self, message: ForeignMessage ) -> Result<(), ForeignError>

Relays a foreign message to an actor on this system. Upon error, the caller should respond to the message with None, unless there is a possibility of recovery.

Errors

Returns an error if the foreign message failed to relay to this system.

Trait Implementations

impl<C: FluxionParams> Clone for Fluxion<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: FluxionParams> System<C> for Fluxion<C>

fn add<'life0, 'life1, 'async_trait, A>( &'life0 self, actor: A, id: &'life1 str ) -> Pin<Box<dyn Future<Output = Option<LocalHandle<C, A>>> + Send + 'async_trait>>where A: 'async_trait + Actor<C>, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Add an actor to the system

Returns

Returns None if the actor was not added to the system. If the actor was added to the system, returns Some containing the actor’s LocalHandle.

fn get_local<'life0, 'life1, 'async_trait, A>( &'life0 self, id: &'life1 str ) -> Pin<Box<dyn Future<Output = Option<LocalHandle<C, A>>> + Send + 'async_trait>>where A: 'async_trait + Actor<C>, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a local actor as a LocalHandle. Useful for running management functions like shutdown on known local actors.

fn get<'life0, 'async_trait, A, M>( &'life0 self, id: ActorId ) -> Pin<Box<dyn Future<Output = Option<Box<dyn MessageSender<M>>>> + Send + 'async_trait>>where M::Response: for<'a> Deserialize<'a>, A: 'async_trait + Handler<C, M>, M: 'async_trait + Message + Serialize, Self: 'async_trait, 'life0: 'async_trait,

Get an actor from its id as a Box<dyn MessageSender>. Use this for most cases, as it will also handle foreign actors.

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes an actor from the system, and waits for it to stop execution

fn foreign_proxy<'life0, 'life1, 'life2, 'async_trait, A, M, R>( &'life0 self, actor_id: &'life1 str, foreign_id: &'life2 str ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>where A: Handler<C, M> + 'async_trait, M: Message<Response = R> + Serialize + for<'a> Deserialize<'a> + 'async_trait, R: Send + Sync + 'static + Serialize + for<'a> Deserialize<'a> + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Initializes foreign message support for an actor.