Skip to main content

RouteController

camel_api::route_controller

Trait RouteController 

Source 
pub trait RouteController: Send + Sync {
    // Required methods
    fn start_route<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        route_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn stop_route<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        route_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn restart_route<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        route_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn suspend_route<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        route_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn resume_route<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        route_id: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn start_all_routes<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn stop_all_routes<'life0, 'async_trait>(
        &'life0 mut self,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

    // Provided method
    fn stop_route_with_budget<'life0, 'life1, 'async_trait>(
        &'life0 mut self,
        route_id: &'life1 str,
        _budget: Duration,
    ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
}
Expand description

Trait for managing route lifecycle operations.

Implementations provide imperative execution operations only; canonical lifecycle state is exposed via runtime query APIs.

Required Methods§

Source

fn start_route<'life0, 'life1, 'async_trait>( &'life0 mut self, route_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Start a specific route by its ID.

§Errors

Returns a CamelError if the route cannot be started.

Source

fn stop_route<'life0, 'life1, 'async_trait>( &'life0 mut self, route_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stop a specific route by its ID.

§Errors

Returns a CamelError if the route cannot be stopped.

Source

fn restart_route<'life0, 'life1, 'async_trait>( &'life0 mut self, route_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restart a specific route by its ID.

§Errors

Returns a CamelError if the route cannot be restarted.

Source

fn suspend_route<'life0, 'life1, 'async_trait>( &'life0 mut self, route_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Suspend a specific route by its ID.

§Errors

Returns a CamelError if the route cannot be suspended.

Source

fn resume_route<'life0, 'life1, 'async_trait>( &'life0 mut self, route_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Resume a suspended route by its ID.

§Errors

Returns a CamelError if the route cannot be resumed.

Source

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

Start all routes in the context.

§Errors

Returns a CamelError if any route cannot be started.

Source

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

Stop all routes in the context.

§Errors

Returns a CamelError if any route cannot be stopped.

Provided Methods§

Source

fn stop_route_with_budget<'life0, 'life1, 'async_trait>( &'life0 mut self, route_id: &'life1 str, _budget: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), CamelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stop a route with a graceful drain budget.

Implementations may bound their drain phase by budget. The default delegates to Self::stop_route, ignoring the budget.

§Errors

Returns a CamelError if the route cannot be stopped.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§