FC++  v0.7.2-1128
FileCatalyst Fast File Transfers - C++ Library
FCOptions.hpp File Reference

Groups together all of the optional settings used to setup connections to FTP servers. More...

#include "FileCatalyst.hpp"
Include dependency graph for FCOptions.hpp:
This graph shows which files directly or indirectly include this file:

Classes

class  fc::Options
 fc::Options contains all the default and user-defined settings required by fc::Control to connect to FTP servers. More...
 

Namespaces

 fc
 All of the FileCatalyst classes and objects are declared within the fc namespace.
 

Enumerations

enum  fc::EClientIdMajor {
  fc::kInvalidMajorId = 0,
  fc::kCli = 3,
  fc::kApi = 7,
  fc::kMobile = 15
}
 
enum  fc::EClientIdMinor {
  fc::kInvalidMinorId = 0,
  fc::kCliJava = 7,
  fc::kCliCpp = 8,
  fc::kApiCpp = 10,
  fc::kMobileUploaderIos = 13,
  fc::kApiIos = 14
}
 
enum  fc::ETransferMode {
  fc::kInvalidTransferMode = 0,
  fc::kFtp = 1,
  fc::kTcp = kFtp,
  fc::kUdp = 2
}
 
enum  fc::EConnectionMode {
  fc::kInvalidConnectionMode = 0,
  fc::kActive = 1,
  fc::kPassive = 2
}
 
enum  fc::ESslHandshakeMode {
  fc::kInvalidSslHandshake = 0,
  fc::kSslAutoDetect = 1,
  fc::kSslFullHandshake = 2,
  fc::kSslSessionReuse = 3
}
 
enum  fc::ECommonBandwidth {
  fc::kInvalidBandwidth = 0,
  fc::kZero_bps = 0,
  fc::k1_Kbps,
  fc::k1200_bps,
  fc::k2400_bps,
  fc::k4800_bps,
  fc::k9600_bps,
  fc::k14_4_Kbps,
  fc::k28_8_Kbps,
  fc::k33_6_Kbps,
  fc::k56_Kbps,
  fc::k64_Kbps,
  fc::k128_Kbps,
  fc::k144_Kbps,
  fc::k236_8_Kbps,
  fc::k256_Kbps,
  fc::k384_Kbps,
  fc::k640_Kbps,
  fc::k768_Kbps,
  fc::k1_Mbps,
  fc::k1_544_Mbps,
  fc::k2_Mbps,
  fc::k2_048_Mbps,
  fc::k2_5_Mbps,
  fc::k3_152_Mbps,
  fc::k3_5_Mbps,
  fc::k4_Mbps,
  fc::k6_312_Mbps,
  fc::k8_448_Mbps,
  fc::k10_Mbps,
  fc::k11_Mbps,
  fc::k16_Mbps,
  fc::k32_064_Mbps,
  fc::k34_368_Mbps,
  fc::k44_736_Mbps,
  fc::k51_84_Mbps,
  fc::k54_Mbps,
  fc::k89_472,
  fc::k97_728_Mbps,
  fc::k100_Mbps,
  fc::k135_Mbps,
  fc::k139_264_Mbps,
  fc::k155_52_Mbps,
  fc::k274_176_Mbps,
  fc::k397_200_Mbps,
  fc::k400_352_Mbps,
  fc::k466_56_Mbps,
  fc::k565_148_Mbps,
  fc::k600_Mbps,
  fc::k622_08_Mbps,
  fc::k933_12_Mbps,
  fc::k1_Gbps,
  fc::k1244_16_Mbps,
  fc::k1_3_Gbps,
  fc::k1866_24_Mbps,
  fc::k2488_32_Mbps,
  fc::k4976_64_Mbps,
  fc::k6_75_Gbps,
  fc::k9953_28_Mbps,
  fc::k10_Gbps,
  fc::k13_1_Gbps,
  fc::k39_813_Gbps,
  fc::k1200Modem = k1200_bps,
  fc::k2400Modem = k2400_bps,
  fc::k9600Modem = k9600_bps,
  fc::k14KModem = k14_4_Kbps,
  fc::k28KModem = k28_8_Kbps,
  fc::k33KModem = k33_6_Kbps,
  fc::k56KModem = k56_Kbps,
  fc::k64KISDN = k64_Kbps,
  fc::k128KISDN = k128_Kbps,
  fc::k144IDSL = k144_Kbps,
  fc::kDS0 = k64_Kbps,
  fc::kDS1 = k1_544_Mbps,
  fc::kDS2 = k6_312_Mbps,
  fc::kDS3 = k44_736_Mbps,
  fc::kDS4 = k274_176_Mbps,
  fc::kT1 = k1_544_Mbps,
  fc::kE1 = k2_048_Mbps,
  fc::kT2 = k6_312_Mbps,
  fc::kT3 = k44_736_Mbps,
  fc::kT4 = k274_176_Mbps,
  fc::kT5 = k400_352_Mbps,
  fc::kOC1 = k51_84_Mbps,
  fc::kOC3 = k155_52_Mbps,
  fc::kOC9 = k466_56_Mbps,
  fc::kOC12 = k622_08_Mbps,
  fc::kOC18 = k933_12_Mbps,
  fc::kOC24 = k1244_16_Mbps,
  fc::kOC36 = k1866_24_Mbps,
  fc::kOC48 = k2488_32_Mbps,
  fc::kOC96 = k4976_64_Mbps,
  fc::kOC192 = k9953_28_Mbps,
  fc::kOC256 = k13_1_Gbps,
  fc::kOC768 = k39_813_Gbps,
  fc::k10BaseX = k10_Mbps,
  fc::k100BaseX = k100_Mbps,
  fc::k1000BaseX = k1_Gbps,
  fc::k10GBaseX = k10_Gbps,
  fc::kEthernet = k10BaseX,
  fc::kFastEthernet = k100BaseX,
  fc::kGigabit = k1000BaseX,
  fc::k10Gigabit = k10GBaseX,
  fc::k80211 = k2_Mbps,
  fc::k80211a = k54_Mbps,
  fc::k80211b = k11_Mbps,
  fc::k80211g = k54_Mbps,
  fc::k80211n = k600_Mbps,
  fc::k80211ac = k1_3_Gbps,
  fc::k80211ad = k6_75_Gbps,
  fc::k1G = k1200_bps,
  fc::k2G = k14_4_Kbps,
  fc::k2_5G = k56_Kbps,
  fc::k2_75G = k236_8_Kbps,
  fc::k3G = k384_Kbps,
  fc::k4G = k100_Mbps
}
 Enumerations for several common bandwidth values. More...
 

Functions

uint64_t fc::bps (const fc::ECommonBandwidth &bandwidth)
 Convert the common bandwidth enum value to a usable bps value. More...
 
uint64_t fc::bps (const int rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::bps (const double rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::Kbps (const int rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::Kbps (const double rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::Mbps (const int rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::Mbps (const double rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::Gbps (const int rate)
 Convert easy-to-use numerical values to bps values. More...
 
uint64_t fc::Gbps (const double rate)
 Convert easy-to-use numerical values to bps values. More...
 

Detailed Description

Groups together all of the optional settings used to setup connections to FTP servers.