Skip to main content

ModuleAdapter

Struct ModuleAdapter 

Source
pub struct ModuleAdapter { /* private fields */ }
Expand description

Adapts an existing start_module(Arc<JanusState>) -> Result<()> function into a JanusService that the supervisor can manage.

§Shutdown Bridging

When the supervisor cancels this service’s CancellationToken, the adapter calls state.request_shutdown() to signal the inner module through its existing shutdown pathway. This avoids having to rewrite every service to accept a CancellationToken directly — they continue polling state.is_shutdown_requested() as before.

§Shared-State Shutdown Invariant

Because JanusState is shared across all modules, request_shutdown() sets a global AtomicBool. This is safe under the current supervisor model because:

  1. The supervisor propagates cancellation to all services at once (child tokens of the same root), so if one bridge fires they all do.
  2. When a service fails on its own (returns Err), the bridge task is aborted before it can call request_shutdown(), keeping the flag false for the restart.
  3. The supervisor checks cancel.is_cancelled() before each restart attempt, so a stale true flag never leads to a restart loop.

If per-module independent restart semantics are ever needed (e.g., restarting one module while others keep running), this must be refactored to use a per-adapter shutdown signal instead of the global JanusState flag.

§Error Propagation

Errors returned by the inner start_module are converted to anyhow::Error and bubbled up to the supervisor, which then applies the configured RestartPolicy.

Implementations§

Source§

impl ModuleAdapter

Source

pub fn new<F>( name: &str, state: Arc<JanusState>, start_fn: F, policy: RestartPolicy, ) -> Self
where F: Fn(Arc<JanusState>) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Create a new adapter.

§Arguments
  • name — Service name for the supervisor (e.g., "forward", "data", "cns").
  • state — Shared JanusState that the module uses for configuration, health reporting, and shutdown signalling.
  • start_fn — A closure or function pointer matching the start_module signature. Must be Send + Sync + 'static.
  • policy — How the supervisor should handle failures.
§Example
let adapter = ModuleAdapter::new(
    "forward",
    state.clone(),
    |s| Box::pin(janus_forward::start_module(s)),
    RestartPolicy::OnFailure,
);
Source

pub fn on_failure<F>(name: &str, state: Arc<JanusState>, start_fn: F) -> Self
where F: Fn(Arc<JanusState>) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Create an adapter with the default RestartPolicy::OnFailure.

Source

pub fn one_shot<F>(name: &str, state: Arc<JanusState>, start_fn: F) -> Self
where F: Fn(Arc<JanusState>) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Create an adapter that never restarts (one-shot module).

Source

pub fn always_restart<F>( name: &str, state: Arc<JanusState>, start_fn: F, ) -> Self
where F: Fn(Arc<JanusState>) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Create an adapter that always restarts (even on clean exit).

Trait Implementations§

Source§

impl Debug for ModuleAdapter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl JanusService for ModuleAdapter

Source§

fn name(&self) -> &str

Returns the unique name of the service for logging, metrics, and supervisor identification. Read more
Source§

fn restart_policy(&self) -> RestartPolicy

The restart policy for this service. Read more
Source§

fn run<'life0, 'async_trait>( &'life0 self, cancel: CancellationToken, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

The main execution loop of the service. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more