Struct hypercore_protocol::Channel

pub struct Channel { /* private fields */ }

A protocol channel.

This is the handle that can be sent to other threads.

Implementations

impl Channel

pub fn discovery_key(&self) -> &[u8; 32]

Get the discovery key of this channel.

pub fn key(&self) -> &[u8; 32]

Get the key of this channel.

pub fn id(&self) -> usize

Get the local wire ID of this channel.

pub fn closed(&self) -> bool

Check if the channel is closed.

pub async fn send(&mut self, message: Message) -> Result<()>

Send a message over the channel.

pub async fn send_batch(&mut self, messages: &[Message]) -> Result<()>

Send a batch of messages over the channel.

pub fn take_receiver(&mut self) -> Option<Receiver<Message>>

Take the receiving part out of the channel.

After taking the receiver, this Channel will not emit messages when polled as a stream. The returned receiver will.

pub fn local_sender(&mut self) -> Sender<Message>

Clone the local sending part of the channel receiver. Useful for direct local communication to the channel listener. Typically you will only want to send a LocalSignal message with this sender to make it clear what event came from the remote peer and what was local signaling.

pub async fn close(&mut self) -> Result<()>

Send a close message and close this channel.

pub async fn signal_local_protocol( &mut self, name: &str, data: Vec<u8> ) -> Result<()>

Signal the protocol to produce Event::LocalSignal. If you want to send a message to the channel level, see take_receiver() and local_sender().

Trait Implementations

impl Debug for Channel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Channel

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Stream for Channel

type Item = Message

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.