Module jax_protocol

Module jax_protocol 

Source
Expand description

JAX Protocol - Custom ALPN protocol for peer status checking and bucket sync

This module implements a custom iroh protocol for:

  • Checking whether a peer is online
  • Checking whether a peer has a specific bucket
  • Checking the sync status of a bucket between peers
  • Fetching the current bucket link from a peer
  • Announcing new bucket versions to peers

Structs§

AnnounceMessage
Announcement of a new bucket version to peers
FetchBucketRequest
Request to fetch the current bucket link from a peer
FetchBucketResponse
Response to a fetch bucket request
JaxProtocol
Protocol handler for the JAX protocol
PingRequest
Request to ping a peer and check bucket sync status
PingResponse
Response to a ping request

Enums§

SyncStatus
Sync status between two peers for a bucket

Constants§

JAX_ALPN
ALPN identifier for the JAX protocol

Traits§

BucketStateProvider
Trait for providing bucket state information to the JAX protocol handler

Functions§

announce_to_peer
Announce a new bucket version to a peer
fetch_bucket
Fetch the current bucket link from a peer
ping_peer
Ping a peer to check the sync status of a bucket