FC++  v0.7.2-1128
FileCatalyst Fast File Transfers - C++ Library
fc::GlobalStats Class Reference

GlobalStats is used to track some summary statistics during file transfers. More...

#include <FCStateAndStats.hpp>

Collaboration diagram for fc::GlobalStats:

Public Member Functions

 GlobalStats (void)
 
GlobalStatsclear (void)
 

Public Attributes

uint64_t totalNumberOfFilesSent
 The total number of files uploaded from the client to the server. More...
 
uint64_t totalNumberOfFilesReceived
 The total number of files downloaded from the server to the client. More...
 
uint64_t remainingNumberOfFilesToSend
 The total number of files left to upload to the server. More...
 
uint64_t remainingNumberOfFilesToReceive
 The total number of files left to download from the server. More...
 
uint64_t totalNumberOfPayloadBytesTransferred
 The total number of bytes that have been uploaded or downloaded. More...
 
uint64_t totalNumberOfPayloadBytesSkipped
 Number of bytes that were skipped due to auto-resume of a previous partial file transfers. More...
 
uint64_t remainingNumberOfPayloadBytesToTransfer
 The number of bytes remaining to upload or download. More...
 
uint64_t bitsPerSecondAverageTransferRate
 The calculated average transfer rate. More...
 
std::chrono::high_resolution_clock::time_point timeStarted
 The absolute time when the current set of transfers started. More...
 
std::chrono::high_resolution_clock::duration timeRemaining
 A relative amount of time, from "now", indicating how much time remains before the current set of transfers has completed. More...
 

Detailed Description

GlobalStats is used to track some summary statistics during file transfers.

Warning
There are no thread locks to the global stats. Some of these values will periodically update during active file transfers.

If access to the statistics is needed during the transfer (versus after the transfer has finished) then please see the statistics callback function fc::Control::setStatsCallback().

Constructor & Destructor Documentation

◆ GlobalStats()

fc::GlobalStats::GlobalStats ( void  )

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

Member Data Documentation

◆ totalNumberOfFilesSent

uint64_t fc::GlobalStats::totalNumberOfFilesSent

The total number of files uploaded from the client to the server.

This number is not reset between transfers unless a call is made to clear().

◆ totalNumberOfFilesReceived

uint64_t fc::GlobalStats::totalNumberOfFilesReceived

The total number of files downloaded from the server to the client.

This value is not reset between transfers unless an explicit call is made to clear().

◆ remainingNumberOfFilesToSend

uint64_t fc::GlobalStats::remainingNumberOfFilesToSend

The total number of files left to upload to the server.

◆ remainingNumberOfFilesToReceive

uint64_t fc::GlobalStats::remainingNumberOfFilesToReceive

The total number of files left to download from the server.

◆ totalNumberOfPayloadBytesTransferred

uint64_t fc::GlobalStats::totalNumberOfPayloadBytesTransferred

The total number of bytes that have been uploaded or downloaded.

This includes bytes that were skipped. This value is not reset between transfers unless an explicit call is made to clear().

See also
totalNumberOfPayloadBytesSkipped

◆ totalNumberOfPayloadBytesSkipped

uint64_t fc::GlobalStats::totalNumberOfPayloadBytesSkipped

Number of bytes that were skipped due to auto-resume of a previous partial file transfers.

This value is not reset between transfers unless an explicit call is made to clear().

Warning
Due to a typo, this was incorrectly called totalNumberOfPlayloadBytesSkipped in older versions of FC++. Client code that was built against FC++ prior to August 2016 and which reference the global stats will need to fix this typo.
See also
totalNumberOfPayloadBytesTransferred
Since
v0.7.1-974, September 2015.

◆ remainingNumberOfPayloadBytesToTransfer

uint64_t fc::GlobalStats::remainingNumberOfPayloadBytesToTransfer

The number of bytes remaining to upload or download.

◆ bitsPerSecondAverageTransferRate

uint64_t fc::GlobalStats::bitsPerSecondAverageTransferRate

The calculated average transfer rate.

◆ timeStarted

std::chrono::high_resolution_clock::time_point fc::GlobalStats::timeStarted

The absolute time when the current set of transfers started.

If there are no active transfers, then this will be the previous set of file transfers.

◆ timeRemaining

std::chrono::high_resolution_clock::duration fc::GlobalStats::timeRemaining

A relative amount of time, from "now", indicating how much time remains before the current set of transfers has completed.


The documentation for this class was generated from the following files: