Struct kompact::KompactSystem

pub struct KompactSystem { /* fields omitted */ }

Methods

impl KompactSystem

pub fn new(conf: KompactConfig) -> Result<Self, KompactError>

pub fn schedule(&self, c: Arc<dyn CoreContainer>)

pub fn logger(&self) -> &KompactLogger

pub fn poison(&self)

pub fn create<C, F>(&self, f: F) -> Arc<Component<C>> where
    F: FnOnce() -> C,
    C: ComponentDefinition + 'static, 

Create a new component.

New components are not started automatically.

pub fn create_unsupervised<C, F>(&self, f: F) -> Arc<Component<C>> where
    F: FnOnce() -> C,
    C: ComponentDefinition + 'static, 

Use this to create system components!

During system initialisation the supervisor is not available, yet, so normal create calls will panic!

pub fn create_and_register<C, F>(
    &self,
    f: F
) -> (Arc<Component<C>>, Future<Result<(), RegistrationError>>) where
    F: FnOnce() -> C,
    C: ComponentDefinition + 'static, 

pub fn create_and_start<C, F>(&self, f: F) -> Arc<Component<C>> where
    F: FnOnce() -> C,
    C: ComponentDefinition + 'static, 

Instantiates the component, registers it with the system dispatcher, and starts its lifecycle.

pub fn register_by_alias<C, A>(
    &self,
    c: &Arc<Component<C>>,
    alias: A
) -> Future<Result<(), RegistrationError>> where
    C: ComponentDefinition + 'static,
    A: Into<String>, 

Attempts to register the provided component with a human-readable alias.

Returns

A Future which resolves to an error if the alias is not unique, and a unit () if successful.

pub fn start<C>(&self, c: &Arc<Component<C>>) where
    C: ComponentDefinition + 'static, 

pub fn start_notify<C>(&self, c: &Arc<Component<C>>) -> Future<()> where
    C: ComponentDefinition + 'static, 

pub fn stop<C>(&self, c: &Arc<Component<C>>) where
    C: ComponentDefinition + 'static, 

pub fn stop_notify<C>(&self, c: &Arc<Component<C>>) -> Future<()> where
    C: ComponentDefinition + 'static, 

pub fn kill<C>(&self, c: Arc<Component<C>>) where
    C: ComponentDefinition + 'static, 

pub fn kill_notify<C>(&self, c: Arc<Component<C>>) -> Future<()> where
    C: ComponentDefinition + 'static, 

pub fn trigger_i<P: Port + 'static>(
    &self,
    msg: P::Indication,
    port: RequiredRef<P>
)

pub fn trigger_r<P: Port + 'static>(
    &self,
    msg: P::Request,
    port: ProvidedRef<P>
)

pub fn throughput(&self) -> usize

pub fn max_messages(&self) -> usize

pub fn await_termination(self)

pub fn shutdown(self) -> Result<(), String>

pub fn system_path(&self) -> SystemPath

Trait Implementations

impl ActorRefFactory for KompactSystem

fn actor_ref(&self) -> ActorRef

impl Dispatching for KompactSystem

fn dispatcher_ref(&self) -> ActorRef

impl ActorSource for KompactSystem

fn path_resolvable(&self) -> PathResolvable

impl TimerRefFactory for KompactSystem

fn timer_ref(&self) -> TimerRef

impl Clone for KompactSystem

fn clone(&self) -> KompactSystem

Returns a copy of the value.

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

Performs copy-assignment from source.