Back to Site
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
librats::FileTransferProgress Struct Reference

File transfer progress information. More...

#include <file_transfer.h>

Collaboration diagram for librats::FileTransferProgress:
[legend]

Public Member Functions

 FileTransferProgress ()
 
double get_completion_percentage () const
 
std::chrono::milliseconds get_elapsed_time () const
 
void update_transfer_rates (uint64_t new_bytes_transferred)
 

Public Attributes

std::string transfer_id
 
std::string peer_id
 
FileTransferDirection direction
 
FileTransferStatus status
 
std::string filename
 
std::string local_path
 
uint64_t file_size
 
uint64_t bytes_transferred
 
uint64_t total_bytes
 
uint32_t chunks_completed
 
uint32_t total_chunks
 
std::chrono::steady_clock::time_point start_time
 
std::chrono::steady_clock::time_point last_update
 
double transfer_rate_bps
 
double average_rate_bps
 
std::chrono::milliseconds estimated_time_remaining
 
std::string error_message
 
uint32_t retry_count
 

Detailed Description

File transfer progress information.

Definition at line 95 of file file_transfer.h.

Constructor & Destructor Documentation

◆ FileTransferProgress()

librats::FileTransferProgress::FileTransferProgress ( )
inline

Definition at line 123 of file file_transfer.h.

References last_update, and start_time.

Member Function Documentation

◆ get_completion_percentage()

double librats::FileTransferProgress::get_completion_percentage ( ) const
inline

Definition at line 134 of file file_transfer.h.

References bytes_transferred, and total_bytes.

◆ get_elapsed_time()

std::chrono::milliseconds librats::FileTransferProgress::get_elapsed_time ( ) const
inline

Definition at line 140 of file file_transfer.h.

References start_time.

◆ update_transfer_rates()

void librats::FileTransferProgress::update_transfer_rates ( uint64_t  new_bytes_transferred)

Member Data Documentation

◆ average_rate_bps

double librats::FileTransferProgress::average_rate_bps

Definition at line 116 of file file_transfer.h.

◆ bytes_transferred

uint64_t librats::FileTransferProgress::bytes_transferred

Definition at line 107 of file file_transfer.h.

Referenced by get_completion_percentage().

◆ chunks_completed

uint32_t librats::FileTransferProgress::chunks_completed

Definition at line 109 of file file_transfer.h.

◆ direction

FileTransferDirection librats::FileTransferProgress::direction

Definition at line 98 of file file_transfer.h.

◆ error_message

std::string librats::FileTransferProgress::error_message

Definition at line 120 of file file_transfer.h.

◆ estimated_time_remaining

std::chrono::milliseconds librats::FileTransferProgress::estimated_time_remaining

Definition at line 117 of file file_transfer.h.

◆ file_size

uint64_t librats::FileTransferProgress::file_size

Definition at line 104 of file file_transfer.h.

◆ filename

std::string librats::FileTransferProgress::filename

Definition at line 102 of file file_transfer.h.

◆ last_update

std::chrono::steady_clock::time_point librats::FileTransferProgress::last_update

Definition at line 114 of file file_transfer.h.

Referenced by FileTransferProgress().

◆ local_path

std::string librats::FileTransferProgress::local_path

Definition at line 103 of file file_transfer.h.

◆ peer_id

std::string librats::FileTransferProgress::peer_id

Definition at line 97 of file file_transfer.h.

◆ retry_count

uint32_t librats::FileTransferProgress::retry_count

Definition at line 121 of file file_transfer.h.

◆ start_time

std::chrono::steady_clock::time_point librats::FileTransferProgress::start_time

Definition at line 113 of file file_transfer.h.

Referenced by FileTransferProgress(), and get_elapsed_time().

◆ status

FileTransferStatus librats::FileTransferProgress::status

Definition at line 99 of file file_transfer.h.

◆ total_bytes

uint64_t librats::FileTransferProgress::total_bytes

Definition at line 108 of file file_transfer.h.

Referenced by get_completion_percentage().

◆ total_chunks

uint32_t librats::FileTransferProgress::total_chunks

Definition at line 110 of file file_transfer.h.

◆ transfer_id

std::string librats::FileTransferProgress::transfer_id

Definition at line 96 of file file_transfer.h.

◆ transfer_rate_bps

double librats::FileTransferProgress::transfer_rate_bps

Definition at line 115 of file file_transfer.h.

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