Loading...
Searching...
No Matches
sf::Ftp::ListingResponse Class Reference
Specialization of FTP response returning a file name listing. More...
#include <SFML/Network/Ftp.hpp>
Inheritance diagram for sf::Ftp::ListingResponse:
Public Member Functions | |
| ListingResponse (const Response &response, const std::string &data) | |
| Default constructor. | |
| const std::vector< std::string > & | getListing () const |
| Return the array of directory/file names. | |
| bool | isOk () const |
| Check if the status code means a success. | |
| Status | getStatus () const |
| Get the status code of the response. | |
| const std::string & | getMessage () const |
| Get the full message contained in the response. | |
Detailed Description
Specialization of FTP response returning a file name listing.
Member Enumeration Documentation
◆ Status
|
stronginherited |
Status codes possibly returned by a FTP response.
Constructor & Destructor Documentation
◆ ListingResponse()
| sf::Ftp::ListingResponse::ListingResponse | ( | const Response & | response, |
| const std::string & | data ) |
Default constructor.
- Parameters
-
response Source response data Data containing the raw listing
Member Function Documentation
◆ getListing()
|
nodiscard |
Return the array of directory/file names.
- Returns
- Array containing the requested listing
◆ getMessage()
|
nodiscardinherited |
Get the full message contained in the response.
- Returns
- The response message
◆ getStatus()
|
nodiscardinherited |
Get the status code of the response.
- Returns
- Status code
◆ isOk()
|
nodiscardinherited |
Check if the status code means a success.
This function is defined for convenience, it is equivalent to testing if the status code is < 400.
- Returns
trueif the status is a success,falseif it is a failure
The documentation for this class was generated from the following file: