Struct StreamContext

pub struct StreamContext {
    pub connection_id: u64,
    pub request_id: u64,
    pub payload_bytes_sent: u64,
    pub other_bytes_sent: u64,
    pub bytes_read: u64,
    pub progress: EventSender,
}

Fields

connection_id: u64

The connection ID from the connection

request_id: u64

The request ID from the recv stream

payload_bytes_sent: u64

The number of bytes written that are part of the payload

other_bytes_sent: u64

The number of bytes written that are not part of the payload

bytes_read: u64

The number of bytes read from the stream

progress: EventSender

The progress sender to send events to

Implementations

impl StreamContext

pub fn log_other_write(&mut self, len: usize)

Increase the write count due to a non-payload write.

pub async fn send_transfer_completed(&mut self)

pub async fn send_transfer_aborted(&mut self)

pub fn notify_payload_write(&mut self, index: u64, offset: u64, len: usize)

Increase the write count due to a payload write, and notify the progress sender.

index is the index of the blob in the request. offset is the offset in the blob where the write started. len is the length of the write.

pub async fn send_get_request_received( &self, hash: &Hash, ranges: &ChunkRangesSeq, )

Send a get request received event.

This sends all the required information to make sense of subsequent events such as Event::TransferStarted and Event::TransferProgress.

pub async fn send_get_many_request_received( &self, hashes: &[Hash], ranges: &ChunkRangesSeq, )

Send a get request received event.

This sends all the required information to make sense of subsequent events such as Event::TransferStarted and Event::TransferProgress.

pub async fn authorize_push_request( &self, hash: &Hash, ranges: &ChunkRangesSeq, ) -> bool

Authorize a push request.

This will send a request to the event sender, and wait for a response if a progress sender is enabled. If not, it will always fail.

We want to make accepting push requests very explicit, since this allows remote nodes to add arbitrary data to our store.

pub async fn send_transfer_started(&self, index: u64, hash: &Hash, size: u64)

Send a transfer started event.

Trait Implementations

impl Debug for StreamContext

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

Formats the value using the given formatter.