Struct vapcore_light::net::LightProtocol

pub struct LightProtocol { /* fields omitted */ }

This is an implementation of the light vapory network protocol, abstracted over a Provider of data and a p2p network.

This is simply designed for request-response purposes. Higher level uses of the protocol, such as synchronization, will function as wrappers around this system.

Implementations

impl LightProtocol

pub fn new(provider: Arc<dyn Provider>, params: Params) -> Self

Create a new instance of the protocol manager.

pub fn peer_status(&self, peer: PeerId) -> Option<Status>

Attempt to get peer status.

pub fn peer_count(&self) -> (usize, usize)

Get number of (connected, active) peers.

pub fn leecher_count(&self) -> usize

Get the number of active light peers downloading from the node

pub fn request_from(
    &self,
    io: &dyn IoContext,
    peer_id: PeerId,
    requests: Requests
) -> Result<ReqId, Error>

Make a request to a peer.

Fails on: nonexistent peer, network error, peer not server, insufficient credits. Does not check capabilities before sending. On success, returns a request id which can later be coordinated with an event.

pub fn make_announcement(&self, io: &dyn IoContext, announcement: Announcement)

Make an announcement of new chain head and capabilities to all peers. The announcement is expected to be valid.

pub fn add_handler(&mut self, handler: Arc<dyn Handler>)

Add an event handler.

These are intended to be added when the protocol structure is initialized as a means of customizing its behavior, and dispatching requests immediately upon events.

pub fn abort(&self)

Signal to handlers that network activity is being aborted and clear peer data.

pub fn handle_packet(
    &self,
    io: &dyn IoContext,
    peer: PeerId,
    packet_id: u8,
    data: &[u8]
)

Handle a packet using the given io context. Packet data is untrusted, which means that invalid data won’t lead to issues.

pub fn on_connect(&self, peer: PeerId, io: &dyn IoContext)

called when a peer connects.

pub fn on_disconnect(&self, peer: PeerId, io: &dyn IoContext)

called when a peer disconnects.

pub fn with_context<F, T>(&self, io: &dyn IoContext, f: F) -> T where
    F: FnOnce(&dyn BasicContext) -> T, 

Execute the given closure with a basic context derived from the I/O context.

Trait Implementations

impl NetworkProtocolHandler for LightProtocol

fn initialize(&self, io: &dyn NetworkContext)

Initialize the handler

fn read(
    &self,
    io: &dyn NetworkContext,
    peer: &PeerId,
    packet_id: u8,
    data: &[u8]
)

Called when new network packet received.

fn connected(&self, io: &dyn NetworkContext, peer: &PeerId)

Called when new peer is connected. Only called when peer supports the same protocol.

fn disconnected(&self, io: &dyn NetworkContext, peer: &PeerId)

Called when a previously connected peer disconnects.

fn timeout(&self, io: &dyn NetworkContext, timer: TimerToken)

Timer function called after a timeout created with NetworkContext::timeout.