Enum Event

pub enum Event {
    ClientConnected {
        connection_id: u64,
        node_id: NodeId,
        permitted: Sender<bool>,
    },
    ConnectionClosed {
        connection_id: u64,
    },
    GetRequestReceived {
        connection_id: u64,
        request_id: u64,
        hash: Hash,
        ranges: ChunkRangesSeq,
    },
    GetManyRequestReceived {
        connection_id: u64,
        request_id: u64,
        hashes: Vec<Hash>,
        ranges: ChunkRangesSeq,
    },
    PushRequestReceived {
        connection_id: u64,
        request_id: u64,
        hash: Hash,
        ranges: ChunkRangesSeq,
        permitted: Sender<bool>,
    },
    TransferStarted {
        connection_id: u64,
        request_id: u64,
        index: u64,
        hash: Hash,
        size: u64,
    },
    TransferProgress {
        connection_id: u64,
        request_id: u64,
        index: u64,
        end_offset: u64,
    },
    TransferCompleted {
        connection_id: u64,
        request_id: u64,
        stats: Box<TransferStats>,
    },
    TransferAborted {
        connection_id: u64,
        request_id: u64,
        stats: Option<Box<TransferStats>>,
    },
}

Provider progress events, to keep track of what the provider is doing.

ClientConnected -> (GetRequestReceived -> (TransferStarted -> TransferProgress*n)*n -> (TransferCompleted | TransferAborted))*n -> ConnectionClosed

Variants

ClientConnected

A new client connected to the provider.

Fields

connection_id: u64

node_id: NodeId

permitted: Sender<bool>

ConnectionClosed

Connection closed.

Fields

connection_id: u64

GetRequestReceived

A new get request was received from the provider.

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

hash: Hash

The root hash of the request.

ranges: ChunkRangesSeq

The exact query ranges of the request.

GetManyRequestReceived

A new get request was received from the provider.

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

hashes: Vec<Hash>

The root hash of the request.

ranges: ChunkRangesSeq

The exact query ranges of the request.

PushRequestReceived

A new get request was received from the provider.

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

hash: Hash

The root hash of the request.

ranges: ChunkRangesSeq

The exact query ranges of the request.

permitted: Sender<bool>

Complete this to permit the request.

TransferStarted

Transfer for the nth blob started.

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

index: u64

The index of the blob in the request. 0 for the first blob or for raw blob requests.

hash: Hash

The hash of the blob. This is the hash of the request for the first blob, the child hash (index-1) for subsequent blobs.

size: u64

The size of the blob. This is the full size of the blob, not the size we are sending.

TransferProgress

Progress of the transfer.

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

index: u64

The index of the blob in the request. 0 for the first blob or for raw blob requests.

end_offset: u64

The end offset of the chunk that was sent.

TransferCompleted

Entire transfer completed.

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

stats: Box<TransferStats>

Statistics about the transfer.

TransferAborted

Entire transfer aborted

Fields

connection_id: u64

The connection id. Multiple requests can be sent over the same connection.

request_id: u64

The request id. There is a new id for each request.

stats: Option<Box<TransferStats>>

Statistics about the part of the transfer that was aborted.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl LazyEvent for Event

fn call(self) -> Event