Struct carrier::channel::Channel

pub struct Channel {
    pub debug_id: String,
    // some fields omitted
}

Fields

debug_id: String

Methods

impl Channel

pub fn new<S: Into<String>>(noise: Transport, debug_id: S) -> Self

pub fn bytes_in_flight(&self) -> usize

pub fn window(&self) -> usize

pub fn is_initiator(&self) -> bool

pub fn recv(&mut self, pkt: EncryptedPacket) -> Result<(), Error>

receive a packet from the wire

pub fn handle_loss(&mut self, loss: LossDetection)

pub fn progress(&mut self) -> Result<ChannelProgress, Error>

progress the channel and return something that happened this needs to be polled until it returns Later or Disconnectd

pub fn stream<M: Into<Vec<u8>>>(&mut self, stream: u32, msg: M)

queue a message

pub fn open<M: Into<Vec<u8>>>(
    &mut self,
    payload: M,
    are_we_initiator: bool
) -> u32

open a new stream, given a header

pub fn header<M: Into<Vec<u8>>>(&mut self, stream: u32, payload: M)

send headers (as a response)

pub fn close(&mut self, stream: u32)

queue a close, stream may still be able to receive (this is half close)

pub fn remove(&mut self, stream: u32)

remove a stream (full close)

pub fn disconnect(&mut self) -> Result<Vec<u8>, Error>

create a disconnect packet

pub fn probe(&mut self)

send probe packets

pub fn config(&mut self, config: Config)

configure network