Struct ockam_channel::SecureChannel

pub struct SecureChannel { /* fields omitted */ }

SecureChannel is an abstraction responsible for sending messages (usually over the network) in encrypted and authenticated way. SecureChannel always has two ends: initiator and responder.

Implementations

impl SecureChannel

pub async fn create_listener<A: Into<Address>>(
    ctx: &Context,
    address: A,
    vault_worker_address: &Address
) -> Result<()>

Create and start channel listener with given address.

pub async fn create<A: Into<Route>>(
    ctx: &mut Context,
    route: A,
    vault_worker_address: &Address
) -> Result<SecureChannelInfo>

Create initiator channel with given route to a remote channel listener.

Trait Implementations

impl Worker for SecureChannel

type Message = Any

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

type Context = Context

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

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

Override initialisation behaviour

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
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Try to open and handle a typed message

pub fn shutdown(&mut self, _context: &mut Self::Context) -> Result<(), Error>

Override shutdown behaviour