Documentation of SFML 1.6

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Public Types | Public Member Functions | List of all members
sf::Ftp::ListingResponse Class Reference

Specialization of FTP response returning a filename lisiting. More...

#include <Ftp.hpp>

Inheritance diagram for sf::Ftp::ListingResponse:
sf::Ftp::Response

Public Types

enum  Status {
  RestartMarkerReply = 110,
  ServiceReadySoon = 120,
  DataConnectionAlreadyOpened = 125,
  OpeningDataConnection = 150,
  Ok = 200,
  PointlessCommand = 202,
  SystemStatus = 211,
  DirectoryStatus = 212,
  FileStatus = 213,
  HelpMessage = 214,
  SystemType = 215,
  ServiceReady = 220,
  ClosingConnection = 221,
  DataConnectionOpened = 225,
  ClosingDataConnection = 226,
  EnteringPassiveMode = 227,
  LoggedIn = 230,
  FileActionOk = 250,
  DirectoryOk = 257,
  NeedPassword = 331,
  NeedAccountToLogIn = 332,
  NeedInformation = 350,
  ServiceUnavailable = 421,
  DataConnectionUnavailable = 425,
  TransferAborted = 426,
  FileActionAborted = 450,
  LocalError = 451,
  InsufficientStorageSpace = 452,
  CommandUnknown = 500,
  ParametersUnknown = 501,
  CommandNotImplemented = 502,
  BadCommandSequence = 503,
  ParameterNotImplemented = 504,
  NotLoggedIn = 530,
  NeedAccountToStore = 532,
  FileUnavailable = 550,
  PageTypeUnknown = 551,
  NotEnoughMemory = 552,
  FilenameNotAllowed = 553,
  InvalidResponse = 1000,
  ConnectionFailed = 1001,
  ConnectionClosed = 1002,
  InvalidFile = 1003
}
 Enumerate all the valid status codes returned in a FTP response. More...
 

Public Member Functions

 ListingResponse (Response Resp, const std::vector< char > &Data)
 Default constructor.
 
std::size_t GetCount () const
 Get the number of filenames in the listing.
 
const std::string & GetFilename (std::size_t Index) const
 Get the Index-th filename in the directory.
 
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

Specialization of FTP response returning a filename lisiting.

Definition at line 214 of file Ftp.hpp.

Member Enumeration Documentation

enum sf::Ftp::Response::Status
inherited

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.

Definition at line 74 of file Ftp.hpp.

Constructor & Destructor Documentation

sf::Ftp::ListingResponse::ListingResponse ( Response  Resp,
const std::vector< char > &  Data 
)

Default constructor.

Parameters
Resp: Source response
Data: Data containing the raw listing

Member Function Documentation

std::size_t sf::Ftp::ListingResponse::GetCount ( ) const

Get the number of filenames in the listing.

Returns
Total number of filenames
const std::string& sf::Ftp::ListingResponse::GetFilename ( std::size_t  Index) const

Get the Index-th filename in the directory.

Parameters
Index: Index of the filename to get
Returns
Index-th filename
const std::string& sf::Ftp::Response::GetMessage ( ) const
inherited

Get the full message contained in the response.

Returns
The response message
Status sf::Ftp::Response::GetStatus ( ) const
inherited

Get the response status code.

Returns
Status code
bool sf::Ftp::Response::IsOk ( ) const
inherited

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: