Struct Engine 

pub struct Engine<B: PollBackend> { /* private fields */ }

The main I/O event loop engine.

The Engine manages:

• Timer scheduling and expiration
• Client registration and event monitoring
• The main event loop
• Fanout control (maximum concurrent operations)

Example

use consortium::engine::{Engine, EngineBaseTimer, EngineClient, PollBackend, ClientId, FANOUT_UNLIMITED};
use std::os::unix::io::RawFd;

// Engine requires a concrete PollBackend implementation.
// See NullBackend in tests for a minimal example.

Implementations

impl<B: PollBackend> Engine<B>

pub fn with_backend(backend: B, fanout: usize) -> Self

Create a new Engine instance with the given backend.

Arguments

• backend - The polling backend implementation
• fanout - Maximum concurrent operations (0 for no limit)

pub fn add_timer(&mut self, timer: EngineBaseTimer) -> TimerId

Add a timer and return its ID

Arguments

• timer - The timer to add

pub fn remove_timer(&mut self, id: TimerId)

Remove a timer by ID

Arguments

• id - The timer ID to remove

pub fn fire_timers(&mut self)

Fire all expired timers

pub fn run(&mut self, timeout: Option<f64>) -> Result<(), EngineError>

Run the engine event loop

Arguments

• timeout - Optional timeout in seconds (None for no limit)

pub fn abort(&mut self, kill: bool)

Abort the engine

Arguments

• kill - If true, force kill all clients

pub fn is_running(&self) -> bool

Check if the engine is running

pub fn exited(&self) -> bool

Check if the engine has exited

pub fn add_client( &mut self, client: Box<dyn EngineClient>, ) -> Result<ClientId, EngineError>

Add a client to the engine

Arguments

• client - The client to add

pub fn remove_client(&mut self, id: ClientId)

Remove a client by ID

Arguments

• id - The client ID to remove

pub fn fanout(&self) -> usize

Get the fanout value

pub fn update_client_events( &mut self, client_id: ClientId, ) -> Result<(), EngineError>

Update client event interests

pub fn stop(&mut self)

Stop the engine event loop.

pub fn evloop_acquire(&mut self)

Increment the event loop reference count. While refcnt > 0, the engine loop stays alive.

pub fn evloop_release(&mut self)

Decrement the event loop reference count. When refcnt reaches 0, the engine stops.

pub fn client_count(&self) -> usize

Get the number of registered clients.

pub fn timerq(&self) -> &TimerQueue

Get the timer queue (immutable).

pub fn timerq_mut(&mut self) -> &mut TimerQueue

Get the timer queue (mutable).

pub fn start_all_clients(&mut self) -> Result<()>

Start all registered clients.