Struct event_manager::EventManager

pub struct EventManager<T> { /* private fields */ }

Allows event subscribers to be registered, connected to the event loop, and later removed.

Implementations

impl<S: MutEventSubscriber> EventManager<S>

pub fn new() -> Result<Self>

Create a new EventManger object.

pub fn new_with_capacity(ready_events_capacity: usize) -> Result<Self>

Creates a new EventManger object with specified event capacity.

Arguments

• ready_events_capacity: maximum number of ready events to be processed a single run. The maximum value of this parameter is EventManager::MAX_READY_EVENTS_CAPACITY.

pub fn run(&mut self) -> Result<usize>

Run the event loop blocking until events are triggered or an error is returned. Calls subscriber.process() for each event.

On success, it returns number of dispatched events or 0 when interrupted by a signal.

pub fn run_with_timeout(&mut self, milliseconds: i32) -> Result<usize>

Wait for events for a maximum timeout of miliseconds or until an error is returned. Calls subscriber.process() for each event.

On success, it returns number of dispatched events or 0 when interrupted by a signal.

impl<S: MutEventSubscriber> EventManager<S>

pub fn remote_endpoint(&self) -> RemoteEndpoint<S>

Available on crate feature remote_endpoint only.

Return a RemoteEndpoint object, that allows interacting with the EventManager from a different thread. Using RemoteEndpoint::call_blocking on the same thread the event loop runs on leads to a deadlock.

Trait Implementations

impl<T: Debug> Debug for EventManager<T>

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

Formats the value using the given formatter.

impl<T: MutEventSubscriber> SubscriberOps for EventManager<T>

fn add_subscriber(&mut self, subscriber: T) -> SubscriberId

Register a subscriber with the event event_manager and returns the associated ID.

fn remove_subscriber(&mut self, subscriber_id: SubscriberId) -> Result<T>

Unregisters and returns the subscriber associated with the provided ID.

fn subscriber_mut(&mut self, subscriber_id: SubscriberId) -> Result<&mut T>

Return a mutable reference to the subscriber associated with the provided id.

fn event_ops(&mut self, subscriber_id: SubscriberId) -> Result<EventOps<'_>>

Returns a EventOps object for the subscriber associated with the provided ID.

type Subscriber = T

Subscriber type for which the operations apply.