Crate hypercore_protocol

Speak hypercore-protocol.

Most basic example:

use hypercore_protocol::{ProtocolBuilder, Event, Message};
use hypercore_protocol::schema::*;
use async_std::prelude::*;

// Start a tcp server.
let listener = async_std::net::TcpListener::bind("localhost:8000").await.unwrap();
async_std::task::spawn(async move {
    let mut incoming = listener.incoming();
    while let Some(Ok(stream)) = incoming.next().await {
        async_std::task::spawn(async move {
            onconnection(stream, false).await
        });
    }
});

// Connect a client.
let stream = async_std::net::TcpStream::connect("localhost:8000").await.unwrap();
onconnection(stream, true).await;

/// Start Hypercore protocol on a TcpStream.
async fn onconnection (stream: async_std::net::TcpStream, is_initiator: bool) {
    let key = vec![0u8; 32];
    let mut protocol = ProtocolBuilder::new(is_initiator).connect(stream);

    while let Ok(event) = protocol.loop_next().await {
        eprintln!("[{}] received event {:?}", is_initiator, event);
        match event {
            Event::Handshake(_remote_key) => {
                protocol.open(key.clone()).await;
            },
            Event::Channel(mut channel) => {
                async_std::task::spawn(async move {
                    channel.want(Want { start: 0, length: None }).await;
                    while let Some(message) = channel.next().await {
                        eprintln!("[{}] received message: {:?}", is_initiator, message);
                    }
                });
            },
            _ => {}
        }
    }
}

See examples/basic.rs for an actual example of how to use a protocol stream.

Modules

schema

The wire messages used by the protocol.

Structs

Channel	A protocol channel.
Protocol	A Protocol stream.
ProtocolBuilder	Build a Protocol instance with options.
ProtocolOptions	Options for a Protocol instance.
ProtocolStream	Event stream interface for a Protocol instance.

Enums

Event	A protocol event.
Message	A protocol message.

Functions

discovery_key