Struct kompact::component::Component

pub struct Component<CD: ComponentTraits> { /* fields omitted */ }

A concrete component instance

The component class itself is application agnostic, but it contains the application specific ComponentDefinition.

Implementations

impl<CD: ComponentTraits> Component<CD>

pub fn definition_mut(&mut self) -> &mut CD

Returns a mutable reference to the underlying component definition.

This can only be done if you have a reference to the component instance that isn't hidden behind an Arc. For example, after the system shuts down and your code holds on to the last reference to a component you can use get_mut or try_unwrap.

pub fn on_definition<T, F>(&self, f: F) -> T where
    F: FnOnce(&mut CD) -> T, 

Execute a function on the underlying ComponentDefinition and return the result

This method will attempt to lock the mutex, and then apply f to the component definition inside the guard.

pub fn logger(&self) -> &KompactLogger

Returns a reference to this component's logger

pub fn is_faulty(&self) -> bool

Returns true if the component is marked as faulty.

pub fn is_active(&self) -> bool

Returns true if the component is marked as active.

pub fn is_destroyed(&self) -> bool

Returns true if the component is marked as destroyed.

pub fn wait_ended(&self)

Wait synchronously for this component be either destroyed or faulty

This component blocks the current thread and hot-waits for the component to become either faulty or destroyed. It is meant mostly for testing and not recommended in production.

pub fn set_recovery_function<F>(&self, f: F) where
    F: FnOnce(FaultContext) -> RecoveryHandler + Send + 'static, 

Set the recovery function for this component

See RecoveryHandler for more information.

Trait Implementations

impl<C> AbstractComponent for Component<C> where
    C: ComponentTraits + ComponentLifecycle, 

fn dyn_definition_mut(
    &mut self
) -> &mut dyn DynamicComponentDefinition<Message = Self::Message>

Returns a mutable reference to the underlying component definition as a DynamicComponentDefinition trait object.

fn lock_dyn_definition(
    &self
) -> Result<DynamicComponentDefinitionMutexGuard<'_, Self::Message>, LockPoisoned>

Locks the component definition mutex and returns a guard that can be dereferenced to access a DynamicComponentDefinition trait object.

fn as_any(&self) -> &dyn Any

Views self as Any. Can be used to downcast to a concrete Component.

impl<CD: ComponentTraits> ActorRefFactory for Component<CD>

type Message = CD::Message

The type of messages carried by references produced by this factory

fn actor_ref(&self) -> ActorRef<CD::Message>

Returns the associated actor reference

impl<CD> ArcWake for Component<CD> where
    CD: ComponentTraits + ComponentLifecycle, 

fn wake_by_ref(arc_self: &Arc<Self>)

Indicates that the associated task is ready to make progress and should be polled.

fn wake(self: Arc<Self>)

Indicates that the associated task is ready to make progress and should be polled.

impl<CD: ComponentTraits> CoreContainer for Component<CD>

fn id(&self) -> Uuid

Returns the component's unique id

fn core(&self) -> &ComponentCore

Returns a reference to the actual component core

fn execute(&self) -> SchedulingDecision

Executes this component on the current thread

fn schedule(&self)

Schedules this component on its associated scheduler

fn type_name(&self) -> &'static str

The descriptive string of the ComponentDefinition type wrapped in this container

fn dyn_message_queue(&self) -> &dyn DynMsgQueue

Returns the underlying message queue of this component without the type information

fn enqueue_control(&self, event: ControlEvent)

Enqueue an event on the component's control queue

fn system(&self) -> &KompactSystem

Returns this component's system

impl<CD: ComponentTraits> Debug for Component<CD>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.