Struct hypercore_protocol::Protocol

pub struct Protocol<R, W> where
    R: AsyncRead + Send + Unpin + 'static,
    W: AsyncWrite + Send + Unpin + 'static,  { /* fields omitted */ }

A Protocol stream.

Implementations

impl<R, W> Protocol<R, W> where
    R: AsyncRead + Send + Unpin + 'static,
    W: AsyncWrite + Send + Unpin + 'static, 

pub fn new(reader: R, writer: W, options: ProtocolOptions) -> Self

Create a new Protocol instance.

pub fn builder(is_initiator: bool) -> ProtocolBuilder

Create a protocol builder.

pub fn is_initiator(&self) -> bool

pub async fn loop_next<'_>(&'_ mut self) -> Result<Event>

Wait for the next protocol event.

This function should be called in a loop until this returns an error.

pub fn remote_key(&self) -> Option<&[u8]>

Get the peer's Noise public key.

Empty before the handshake completed.

pub fn destroy(&mut self, error: Error)

Destroy the protocol instance with an error.

pub async fn open<'_>(&'_ mut self, key: Vec<u8>) -> Result<()>

Open a new protocol channel.

Once the other side proofed that it also knows the key, the channel is emitted as Event::Channel on the protocol event stream.

pub fn release(self) -> (R, W)

Stop the protocol and return the inner reader and writer.

pub fn into_stream(self) -> ProtocolStream<R, W>

Convert the protocol into a Stream of Events.

pub fn control(&self) -> ControlTx

Get a sender to send control events.