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

A collection of public definitions and functions for convenience. More...

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

Classes

struct  fc::FileDetails
 A collection of file or directory properties returned when a directory listing has been requested. More...
 

Namespaces

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

Typedefs

typedef std::vector< std::string > fc::StrVec
 Defined for convenience: a vector of text strings. More...
 
typedef std::map< std::string, std::string > fc::StrMap
 Defined for convenience: an ordered map where both the key and the value are text strings. More...
 
typedef std::set< std::string > fc::StrSet
 Defined for convenience: an ordered set of text strings. More...
 
typedef std::vector< FileDetails > fc::FDVec
 A std::vector of fc::FileDetails. More...
 

Enumerations

enum  fc::FtpServerReplyCodes {
  fc::k110RestartMarkerReply = 110,
  fc::k120ServiceReadyInMinutes = 120,
  fc::k125DataConnectionAlreadyOpen = 125,
  fc::k150FileStatusOkayOpenDataConnection = 150,
  fc::k200CommandOkay = 200,
  fc::k202CommandNotImplemented = 202,
  fc::k211SystemStatus = 211,
  fc::k212DirectoryStatus = 212,
  fc::k213FileStatus = 213,
  fc::k214HelpMessage = 214,
  fc::k215OperatingSystem = 215,
  fc::k220ReadyForNewUser = 220,
  fc::k221ClosingConnectionLoggedOut = 221,
  fc::k225DataConnectionOpen = 225,
  fc::k226ClosingDataConnectionTransferDone = 226,
  fc::k227ServerOpenedPassiveConnection = 227,
  fc::k228ServerEnteringLongPassiveMode = 228,
  fc::k229ServerEnteringExtendedPassiveMode = 229,
  fc::k230UserLoggedIn = 230,
  fc::k231UserLoggedOut = 231,
  fc::k232WillLogoutWhenTransferCompletes = 232,
  fc::k234SecurityDataExchangeComplete = 234,
  fc::k250RequestedActionOkay = 250,
  fc::k252Echo = 252,
  fc::k255InTargetDirectoryAlready = 255,
  fc::k257PathCreatedOrDirectoryStatus = 257,
  fc::k331SendPassword = 331,
  fc::k332NeedAccountForLogin = 332,
  fc::k350RequestedActionPendingFurtherInfo = 350,
  fc::k421ServiceNotAvailableClosingControl = 421,
  fc::k425CannotOpenDataConnection = 425,
  fc::k426DataConnectionClosedAbnormally = 426,
  fc::k430InvalidUsernameOrPassword = 430,
  fc::k431TemporarilyUnableToProcessSecurity = 431,
  fc::k434RequestedHostUnavailable = 434,
  fc::k450ActionNotTakenBusyOrUnavailable = 450,
  fc::k451ActionAbortedLocalError = 451,
  fc::k452ActionNotTakenOutOfDiskSpace = 452,
  fc::k500CommandNotRecognized = 500,
  fc::k501ErrorInParametersOrArguments = 501,
  fc::k502CommandNotImplemented = 502,
  fc::k503BadSequenceOfCommands = 503,
  fc::k504CommandNotImplementedWithParm = 504,
  fc::k521DataConnectionCannotBeOpened = 521,
  fc::k530NotLoggedIn = 530,
  fc::k532NeedAccount = 532,
  fc::k533CommandProtectionLevelDenied = 533,
  fc::k534RequestDeniedDueToPolicy = 534,
  fc::k550RequestAbortedFileOrDirectoryError = 550,
  fc::k551RequestAbortedPageTypeUnknown = 551,
  fc::k552RequestAbortedOutOfDiskSpace = 552,
  fc::k553RequestAbortedIllegalFilename = 553,
  fc::kInvalid = 0,
  fc::k1xxMore = -1,
  fc::k2xxOkay = -2,
  fc::k3xxPending = -3,
  fc::kAny = -4,
  fc::kOkay = -5,
  fc::kNotOkay = -6,
  fc::kDataConnectionReady = -7,
  fc::kNone = -8
}
 An enum to represent possible FTP server reply code. More...
 

Functions

const StrMap & fc::emptyMap (void)
 Function that always returns an empty map. Used internally by FC++. More...
 
std::string fc::baseVersionStr (void)
 Return a simple version string. More...
 
std::string fc::libfcVersionStr (void)
 Return the version string of the FC++ library. More...
 
int fc::libfcBitSize (void)
 Determine if the library was built for a 32-bit or 64-bit platform. More...
 
std::string fc::opensslVersionStr (void)
 Determine the version of OpenSSL used by FC++. More...
 
fc::FtpServerReplyCodes fc::getCodeFromServerReply (const std::string &reply)
 Parse the given string and return the 3-digit FTP status code. More...
 
std::string fc::getTextFromServerReply (const std::string &reply)
 Parse the given string and return only the last line of text following the 3-digit FTP status code. More...
 

Detailed Description

A collection of public definitions and functions for convenience.