Struct Connection

pub struct Connection<T> { /* private fields */ }

Low-level connection type that handles basic channel idx bookkeeping and inbound event buffering.

Implementations

impl<T> Connection<T>

pub fn inner(&self) -> &T

pub fn inner_mut(&mut self) -> &mut T

Returns a mutable reference to the inner recv instance. Note that using this to recv messages can break the bookkeeping, so use caution.

pub fn into_inner(self) -> T

pub fn protocol(&self) -> Topic

pub fn initiator(&self) -> Creator

pub fn peer_data(&self) -> &PeerData

pub fn num_open_channels(&self) -> usize

Returns the number of open channels in the internal channel table. This includes channels opened in response to pending events that are buffered and need to be processed.

pub fn has_pending_events(&self) -> bool

Returns if there’s events that have been produced but not consumed yet.

impl<T: AsyncRecvFrame> Connection<T>

pub async fn next_event(&mut self) -> Result<Option<InbEvent>, Error>

Takes the next event out of the buffer or, if empty, waits for a new event to be produced.

impl<T: AsyncSendFrame> Connection<T>

pub async fn open_channel( &mut self, topic: Topic, payload: Vec<u8>, flags: MsgFlags, ) -> Result<u32, Error>

Opens a channel on a topic with a channel, optionally closing our end of it immediately.

pub async fn send_message( &mut self, chan_id: u32, payload: Vec<u8>, flags: MsgFlags, ) -> Result<bool, Error>

Sends a message on a channel that we haven’t closed ourselves yet. Returns if the channel is kept alive after this.

pub async fn close_channel(&mut self, chan_id: u32) -> Result<bool, Error>

Close a channel without sending a message. Returns if the channel is kept alive after this.

pub async fn send_notification( &mut self, topic: Topic, message: Vec<u8>, ) -> Result<(), Error>

Sends a notification on a topic.