Struct ockam::RelayService

#[non_exhaustive]
pub struct RelayService { /* private fields */ }

Alias worker to register remote workers under local names.

To talk with this worker, you can use the RemoteRelay which is a compatible client for this server.

Implementations

impl RelayService

pub async fn create( ctx: &Context, address: impl Into<Address>, options: RelayServiceOptions ) -> Result<()>

Start a forwarding service

Trait Implementations

impl Worker for RelayService

type Context = Context

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

type Message = Any

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

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Try to open and handle a typed message.

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

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>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Override shutdown behaviour.