sf::Ftp::Response Class Reference
This class wraps a FTP response, which is basically : More...
#include <Ftp.hpp>
Inheritance diagram for sf::Ftp::Response:
Public Member Functions | |
| Response (Status Code=InvalidResponse, const std::string &Message="") | |
| Default constructor. | |
| bool | IsOk () const |
| Convenience function to check if the response status code means a success. | |
| Status | GetStatus () const |
| Get the response status code. | |
| const std::string & | GetMessage () const |
| Get the full message contained in the response. | |
Detailed Description
This class wraps a FTP response, which is basically :
- a status code
- a message
Member Enumeration Documentation
Enumerate all the valid status codes returned in a FTP response.
- Enumerator:
RestartMarkerReply Restart marker reply.
ServiceReadySoon Service ready in N minutes.
DataConnectionAlreadyOpened Data connection already opened, transfer starting.
OpeningDataConnection File status ok, about to open data connection.
Ok Command ok.
PointlessCommand Command not implemented.
SystemStatus System status, or system help reply.
DirectoryStatus Directory status.
FileStatus File status.
HelpMessage Help message.
SystemType NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
ServiceReady Service ready for new user.
ClosingConnection Service closing control connection.
DataConnectionOpened Data connection open, no transfer in progress.
ClosingDataConnection Closing data connection, requested file action successful.
EnteringPassiveMode Entering passive mode.
LoggedIn User logged in, proceed. Logged out if appropriate.
FileActionOk Requested file action ok.
DirectoryOk PATHNAME created.
NeedPassword User name ok, need password.
NeedAccountToLogIn Need account for login.
NeedInformation Requested file action pending further information.
ServiceUnavailable Service not available, closing control connection.
DataConnectionUnavailable Can't open data connection.
TransferAborted Connection closed, transfer aborted.
FileActionAborted Requested file action not taken.
LocalError Requested action aborted, local error in processing.
InsufficientStorageSpace Requested action not taken; insufficient storage space in system, file unavailable.
CommandUnknown Syntax error, command unrecognized.
ParametersUnknown Syntax error in parameters or arguments.
CommandNotImplemented Command not implemented.
BadCommandSequence Bad sequence of commands.
ParameterNotImplemented Command not implemented for that parameter.
NotLoggedIn Not logged in.
NeedAccountToStore Need account for storing files.
FileUnavailable Requested action not taken, file unavailable.
PageTypeUnknown Requested action aborted, page type unknown.
NotEnoughMemory Requested file action aborted, exceeded storage allocation.
FilenameNotAllowed Requested action not taken, file name not allowed.
InvalidResponse Response is not a valid FTP one.
ConnectionFailed Connection with server failed.
ConnectionClosed Connection with server closed.
InvalidFile Invalid file to upload / download.
Constructor & Destructor Documentation
| sf::Ftp::Response::Response | ( | Status | Code = InvalidResponse, |
| const std::string & | Message = "" |
||
| ) |
Member Function Documentation
| const std::string& sf::Ftp::Response::GetMessage | ( | ) | const |
Get the full message contained in the response.
- Returns
- The response message
| Status sf::Ftp::Response::GetStatus | ( | ) | const |
Get the response status code.
- Returns
- Status code
| bool sf::Ftp::Response::IsOk | ( | ) | const |
Convenience function to check if the response status code means a success.
- Returns
- True if status is success (code < 400)
The documentation for this class was generated from the following file: