Trait ockam::Worker

pub trait Worker: 'static + Send {
    type Message: Message;
    type Context: 'static + Send;

    fn initialize<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        _context: &'life1 mut Self::Context
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn shutdown<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        _context: &'life1 mut Self::Context
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
    fn handle_message<'life0, 'life1, 'async_trait>(
        &'life0 mut self, 
        _context: &'life1 mut Self::Context, 
        _msg: Routed<Self::Message>
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait,
    { ... }
}

Defines the core interface shared by all Ockam Workers.

While all methods do not need to be implemented, at the very least, the Context and Message types need to be specified before a worker can be used in any call to a Context API such as context.start_worker(...).

Required Associated Types

type Message: Message

The type of Message the Worker is sent in Self::handle_message.

type Context: 'static + Send

The API and other resources available for the worker during message processing.

Currently, this should be always ockam::Context or ockam_node::Context (which are the same type), but in the future custom node implementations may use a different context type.

Provided Methods

fn initialize<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _context: &'life1 mut Self::Context
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Override initialisation behaviour.

fn shutdown<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _context: &'life1 mut Self::Context
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Override shutdown behaviour.

fn handle_message<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _context: &'life1 mut Self::Context,
    _msg: Routed<Self::Message>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Try to open and handle a typed message.

Implementations on Foreign Types

impl Worker for NullWorker

type Context = Context

type Message = ()

impl<V, K> Worker for SecureChannelWorker<V, K> where
    V: SecureChannelVault,
    K: SecureChannelKeyExchanger, 

type Message = Any

type Context = Context

fn initialize<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    ctx: &'life1 mut <SecureChannelWorker<V, K> as Worker>::Context
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    SecureChannelWorker<V, K>: 'async_trait, 

fn handle_message<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    ctx: &'life1 mut <SecureChannelWorker<V, K> as Worker>::Context,
    msg: Routed<<SecureChannelWorker<V, K> as Worker>::Message>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    SecureChannelWorker<V, K>: 'async_trait, 

impl<V, N> Worker for SecureChannelListener<V, N> where
    V: SecureChannelVault,
    N: SecureChannelNewKeyExchanger, 

type Message = CreateResponderChannelMessage

type Context = Context

fn handle_message<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    ctx: &'life1 mut <SecureChannelListener<V, N> as Worker>::Context,
    msg: Routed<<SecureChannelListener<V, N> as Worker>::Message>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    SecureChannelListener<V, N>: 'async_trait, 

Implementors

impl Worker for PipeListener

type Context = Context

type Message = InternalCmd

impl Worker for PipeReceiver

type Context = Context

type Message = Any

impl Worker for PipeSender

type Context = Context

type Message = Any

impl Worker for RemoteForwarder

type Context = Context

type Message = Any

impl Worker for ForwardingService

type Context = Context

type Message = Any

impl Worker for Echoer

type Context = Context

type Message = String