Struct carrier::conduit::Conduit

pub struct Conduit { /* fields omitted */ }

A conduit is a combined subscribe+connect client that subscribes to all devices on a shadow and streams data from them. For convenience, most common functionality is implemented into this struct, and users only need to implement handling the data.

Methods

impl Conduit

pub fn new(poll: Poll, config: Config) -> Task<Result<Self, Error>>

create a new conduit as a future. it will subscribe to the shadow address and maintain a connection to all peers on it

pub fn schedule<F, M>(&mut self, every: Duration, headers: Headers, f: F) where
    F: 'static + FnMut(&Identity, M) + Clone,
    M: Message + Default, 

schedule opening a stream on all devices with the given headers

every is the restart delay, that means if a stream is closed, it wont be restarted before delay expired. You can use this to poll a get endpoint.

pub fn schedule_small<F, M>(&mut self, every: Duration, headers: Headers, f: F) where
    F: 'static + FnMut(&Identity, M) + Clone,
    M: Message + Default, 

schedule opening a small stream on all devices with the given headers

decodes each datagram as message without size prefix, like old carrier clients did

pub fn schedule_raw<F>(&mut self, every: Duration, headers: Headers, f: F) where
    F: 'static + FnMut(&Identity, Vec<u8>) + Clone, 

schedule opening a raw stream on all devices with the given headers

gives you all datagrams as bytes

pub fn schedule_null_terminated<F>(
    &mut self,
    every: Duration,
    headers: Headers,
    f: F
) where
    F: 'static + FnMut(&Identity, Vec<u8>) + Clone, 

schedule opening a stream where each message is terminated with \0

it is memory unbounded, meaning an infinite stream will OOM your system

this stream type was a bad idea and you should only use it if you have legacy devices out there that need it

pub fn call<F, M>(&mut self, target: Identity, headers: Headers, f: F) where
    F: 'static + FnMut(&Identity, M) + Clone,
    M: Message + Default, 

open a stream on a specific peer, once

Trait Implementations

impl Future<Result<(), Error>> for Conduit

fn poll(&mut self) -> FutureResult<Result<(), Error>>