Struct ockam::Executor

pub struct Executor { /* private fields */ }

Underlying Ockam node executor

This type is a small wrapper around an inner async runtime (tokio by default) and the Ockam router. In most cases it is recommended you use the ockam::node function annotation instead!

Implementations

impl Executor

pub fn new(rt: Arc<Runtime>, flow_controls: &FlowControls) -> Executor

Create a new Ockam node Executor instance

pub async fn start_router(&mut self) -> Result<(), Error>

Start the router asynchronously

pub fn execute<F, T, E>( &mut self, future: F ) -> Result<<F as Future>::Output, Error>

where F: Future<Output = Result<T, E>> + Send + 'static, T: Send + 'static, E: Send + 'static,

Initialise and run the Ockam node executor context

In this background this launches async execution of the Ockam router, while blocking execution on the provided future.

Any errors encountered by the router or provided application code will be returned from this function.

pub fn execute_no_abort<F, T>( &mut self, future: F ) -> Result<<F as Future>::Output, Error>

where F: Future<Output = T> + Send + 'static, T: Send + 'static,

Initialise and run the Ockam node executor context

In this background this launches async execution of the Ockam router, while blocking execution on the provided future.

Any errors encountered by the router or provided application code will be returned from this function.

Don’t abort the router in case of a failure

pub fn execute_future<F>(future: F) -> Result<<F as Future>::Output, Error>

where F: Future + Send + 'static, <F as Future>::Output: Send + 'static,

Execute a future and block until a result is returned This function can only be called to run futures before the Executor has been initialized. Otherwise the Executor rt attribute needs to be accessed to execute or spawn futures