librats::FileTransfer::Progress Struct Reference

Snapshot passed to the progress callback (both directions). More...

#include <file_transfer.h>

Collaboration diagram for librats::FileTransfer::Progress:

Public Member Functions
double	percent () const
	Completion in [0, 100].

Public Attributes
uint64_t	id = 0
PeerId	peer
Direction	direction = Direction::Sending
Status	status = Status::Pending
uint64_t	bytes_transferred = 0
uint64_t	total_bytes = 0
uint32_t	files_completed = 0
uint32_t	total_files = 0
double	transfer_rate_bps = 0.0
	recent (smoothed) throughput, bytes/sec
double	average_rate_bps = 0.0
	mean throughput since the transfer went live
std::chrono::milliseconds	elapsed {0}
	time since it went live
std::chrono::milliseconds	estimated_time_remaining {0}
	ETA at the recent rate (0 = unknown)

Detailed Description

Snapshot passed to the progress callback (both directions).

Definition at line 99 of file file_transfer.h.

Member Function Documentation

percent()

double librats::FileTransfer::Progress::percent ( ) const

inline

Completion in [0, 100].

Definition at line 115 of file file_transfer.h.

References bytes_transferred, librats::FileTransfer::Completed, status, and total_bytes.

Member Data Documentation

average_rate_bps

double librats::FileTransfer::Progress::average_rate_bps = 0.0

mean throughput since the transfer went live

Definition at line 110 of file file_transfer.h.

bytes_transferred

uint64_t librats::FileTransfer::Progress::bytes_transferred = 0

Definition at line 104 of file file_transfer.h.

Referenced by percent().

direction

Direction librats::FileTransfer::Progress::direction = Direction::Sending

Definition at line 102 of file file_transfer.h.

elapsed

std::chrono::milliseconds librats::FileTransfer::Progress::elapsed {0}

time since it went live

Definition at line 111 of file file_transfer.h.

estimated_time_remaining

std::chrono::milliseconds librats::FileTransfer::Progress::estimated_time_remaining {0}

ETA at the recent rate (0 = unknown)

Definition at line 112 of file file_transfer.h.

files_completed

uint32_t librats::FileTransfer::Progress::files_completed = 0

Definition at line 106 of file file_transfer.h.

id

uint64_t librats::FileTransfer::Progress::id = 0

Definition at line 100 of file file_transfer.h.

peer

PeerId librats::FileTransfer::Progress::peer

Definition at line 101 of file file_transfer.h.

status

Status librats::FileTransfer::Progress::status = Status::Pending

Definition at line 103 of file file_transfer.h.

Referenced by percent().

total_bytes

uint64_t librats::FileTransfer::Progress::total_bytes = 0

Definition at line 105 of file file_transfer.h.

Referenced by percent().

total_files

uint32_t librats::FileTransfer::Progress::total_files = 0

Definition at line 107 of file file_transfer.h.

transfer_rate_bps

double librats::FileTransfer::Progress::transfer_rate_bps = 0.0

recent (smoothed) throughput, bytes/sec

Definition at line 109 of file file_transfer.h.

---

The documentation for this struct was generated from the following file:

• subsystems/file_transfer.h