Struct BackgroundScheduler 

pub struct BackgroundScheduler { /* private fields */ }

The autonomous executor running in this process.

Submit and result transports are abstracted behind MessageTransport so the scheduler can ride either the canonical MPMC SharedRing or the SPMC SharedDeque<PassSlot> work-stealing transport. The constructor picks per workload topology.

Implementations

impl BackgroundScheduler

pub fn start( submit_path: impl AsRef<Path>, result_path: impl AsRef<Path>, heartbeat_path: impl AsRef<Path>, capacity: usize, heartbeat_capacity: usize, ) -> Result<Self, SchedError>

Create a new scheduler. Opens the submit + result rings and the heartbeat table; registers this process; spawns the worker thread that drains the submit ring.

pub fn start_with_transports( submit_ring: Arc<dyn MessageTransport>, result_ring: Arc<dyn MessageTransport>, heartbeat_path: impl AsRef<Path>, heartbeat_capacity: usize, ) -> Result<Self, SchedError>

Construct a scheduler from caller-supplied transports. Lets the caller pick the wire-format primitive at the transport layer (canonical SharedRing MPMC, SPMC SharedDeque<PassSlot>, or any other future MessageTransport impl).

pub fn start_by_workload_shape( submit_path: impl AsRef<Path>, submit_shape: MmfWorkloadShape, result_path: impl AsRef<Path>, result_shape: MmfWorkloadShape, heartbeat_path: impl AsRef<Path>, capacity: usize, heartbeat_capacity: usize, ) -> Result<(Self, MmfFamily, MmfFamily), SchedError>

Construct a scheduler with transports picked by MmfDispatcher from caller-supplied workload shapes. The submit-side and result-side shapes can differ (the canonical pair is StreamingMpmc for submit and WorkStealing(producer_fast(K)) for result). Returns the scheduler plus the picked families so the caller can confirm the routing decision matched expectations.

SharedRing and SharedDeque<PassSlot> are the two supported transport families; MmfFamily::SharedHashMap is rejected with SchedError::UnsupportedTransportFamily because the scheduler’s wire format is push / pop, not key / value.

pub fn submitter(&self) -> Submitter

Get a submitter handle (cheap clone-friendly).

pub fn collector(&self) -> ResultCollector

Get a result collector handle.

pub fn heartbeat(&self) -> Arc<HeartbeatTable>

Access the heartbeat table for failover-watchdog usage.

pub fn slot_idx(&self) -> usize

The slot index this scheduler claimed in the heartbeat table.

pub fn watchdog_scan(&self) -> ReclaimReport

One scan of the watchdog (typically called from the coordinator process’s main loop). Returns reclaim report.

Trait Implementations

impl AdaptiveInstance for BackgroundScheduler

fn header(&self) -> &HandshakeHeader

fn ring(&self) -> &ObservationRing

fn make_policy(&self) -> Box<dyn Policy>

fn apply_migration(&self, new_tag: u32)

Called by the sidecar when the policy returns a new strategy tag. Default implementation: just set the tag on the header. Primitives that need heavier migration (data-layout swap) override this to perform the swap before (or after) updating the tag.

impl Drop for BackgroundScheduler

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.