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

Combine both state and statistics into a single class which callers can access. More...

#include <FCStateAndStats.hpp>

Collaboration diagram for fc::GlobalStateAndStats:

Public Types

enum  EState {
  kInvalid = -1,
  kUnknown = 0,
  kNotConnected,
  kConnecting,
  kConnected,
  kTransferring,
  kPauseForRetry
}
 

Public Member Functions

 GlobalStateAndStats (void)
 
GlobalStateAndStatsclear (void)
 

Public Attributes

EState state
 Global state of the FC++ library. More...
 
GlobalStats stats
 Global statistics. More...
 
TransferStatsMap fileStatsMap
 Track statistics on all individual file transfers. More...
 
size_t fileStatsIdx
 During file transfers, the FC++ library will update this index into fc::GlobalStateAndStats::fileStatsMap to indicate which file is being transferred. More...
 

Detailed Description

Combine both state and statistics into a single class which callers can access.

Member Enumeration Documentation

◆ EState

Enumerator
kInvalid 
kUnknown 
kNotConnected 
kConnecting 
kConnected 

connection is established, no transfer in progress

kTransferring 

file transfer in progress

kPauseForRetry 

see fc::Options::setRetries()

Constructor & Destructor Documentation

◆ GlobalStateAndStats()

fc::GlobalStateAndStats::GlobalStateAndStats ( void  )

References fc::GlobalStats::clear().

Here is the call graph for this function:

Member Function Documentation

◆ clear()

fc::GlobalStateAndStats & fc::GlobalStateAndStats::clear ( void  )

References fc::TransferStats::clear(), FC_WHERE, kTransferring, kUnknown, and stats.

Here is the call graph for this function:

Member Data Documentation

◆ state

EState fc::GlobalStateAndStats::state

Global state of the FC++ library.

◆ stats

GlobalStats fc::GlobalStateAndStats::stats

Global statistics.

◆ fileStatsMap

TransferStatsMap fc::GlobalStateAndStats::fileStatsMap

Track statistics on all individual file transfers.

◆ fileStatsIdx

size_t fc::GlobalStateAndStats::fileStatsIdx

During file transfers, the FC++ library will update this index into fc::GlobalStateAndStats::fileStatsMap to indicate which file is being transferred.


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