Ftp.h

Go to the documentation of this file.

 
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_FTP_H
#define SFML_FTP_H
 
// Headers
#include <SFML/Network/Export.h>
#include <SFML/Network/IpAddress.h>
#include <SFML/Network/Types.h>
#include <stddef.h>
 
 
typedef enum
{
    sfFtpBinary, 
    sfFtpAscii,  
    sfFtpEbcdic  
} sfFtpTransferMode;
 
 
typedef enum
{
    // 1xx: the requested action is being initiated,
    // expect another reply before proceeding with a new command
    sfFtpRestartMarkerReply          = 110, 
    sfFtpServiceReadySoon            = 120, 
    sfFtpDataConnectionAlreadyOpened = 125, 
    sfFtpOpeningDataConnection       = 150, 
 
    // 2xx: the requested action has been successfully completed
    sfFtpOk                    = 200, 
    sfFtpPointlessCommand      = 202, 
    sfFtpSystemStatus          = 211, 
    sfFtpDirectoryStatus       = 212, 
    sfFtpFileStatus            = 213, 
    sfFtpHelpMessage           = 214, 
    sfFtpSystemType            = 215, 
    sfFtpServiceReady          = 220, 
    sfFtpClosingConnection     = 221, 
    sfFtpDataConnectionOpened  = 225, 
    sfFtpClosingDataConnection = 226, 
    sfFtpEnteringPassiveMode   = 227, 
    sfFtpLoggedIn              = 230, 
    sfFtpFileActionOk          = 250, 
    sfFtpDirectoryOk           = 257, 
 
    // 3xx: the command has been accepted, but the requested action
    // is dormant, pending receipt of further information
    sfFtpNeedPassword       = 331, 
    sfFtpNeedAccountToLogIn = 332, 
    sfFtpNeedInformation    = 350, 
 
    // 4xx: the command was not accepted and the requested action did not take place,
    // but the error condition is temporary and the action may be requested again
    sfFtpServiceUnavailable        = 421, 
    sfFtpDataConnectionUnavailable = 425, 
    sfFtpTransferAborted           = 426, 
    sfFtpFileActionAborted         = 450, 
    sfFtpLocalError                = 451, 
    sfFtpInsufficientStorageSpace  = 452, 
 
    // 5xx: the command was not accepted and
    // the requested action did not take place
    sfFtpCommandUnknown          = 500, 
    sfFtpParametersUnknown       = 501, 
    sfFtpCommandNotImplemented   = 502, 
    sfFtpBadCommandSequence      = 503, 
    sfFtpParameterNotImplemented = 504, 
    sfFtpNotLoggedIn             = 530, 
    sfFtpNeedAccountToStore      = 532, 
    sfFtpFileUnavailable         = 550, 
    sfFtpPageTypeUnknown         = 551, 
    sfFtpNotEnoughMemory         = 552, 
    sfFtpFilenameNotAllowed      = 553, 
 
    // 10xx: SFML custom codes
    sfFtpInvalidResponse  = 1000, 
    sfFtpConnectionFailed = 1001, 
    sfFtpConnectionClosed = 1002, 
    sfFtpInvalidFile      = 1003  
} sfFtpStatus;
 
 
CSFML_NETWORK_API void sfFtpListingResponse_destroy(sfFtpListingResponse* ftpListingResponse);
 
CSFML_NETWORK_API sfBool sfFtpListingResponse_isOk(const sfFtpListingResponse* ftpListingResponse);
 
CSFML_NETWORK_API sfFtpStatus sfFtpListingResponse_getStatus(const sfFtpListingResponse* ftpListingResponse);
 
CSFML_NETWORK_API const char* sfFtpListingResponse_getMessage(const sfFtpListingResponse* ftpListingResponse);
 
CSFML_NETWORK_API size_t sfFtpListingResponse_getCount(const sfFtpListingResponse* ftpListingResponse);
 
CSFML_NETWORK_API const char* sfFtpListingResponse_getName(const sfFtpListingResponse* ftpListingResponse, size_t index);
 
CSFML_NETWORK_API void sfFtpDirectoryResponse_destroy(sfFtpDirectoryResponse* ftpDirectoryResponse);
 
CSFML_NETWORK_API sfBool sfFtpDirectoryResponse_isOk(const sfFtpDirectoryResponse* ftpDirectoryResponse);
 
CSFML_NETWORK_API sfFtpStatus sfFtpDirectoryResponse_getStatus(const sfFtpDirectoryResponse* ftpDirectoryResponse);
 
CSFML_NETWORK_API const char* sfFtpDirectoryResponse_getMessage(const sfFtpDirectoryResponse* ftpDirectoryResponse);
 
CSFML_NETWORK_API const char* sfFtpDirectoryResponse_getDirectory(const sfFtpDirectoryResponse* ftpDirectoryResponse);
 
 
CSFML_NETWORK_API void sfFtpResponse_destroy(sfFtpResponse* ftpResponse);
 
CSFML_NETWORK_API sfBool sfFtpResponse_isOk(const sfFtpResponse* ftpResponse);
 
CSFML_NETWORK_API sfFtpStatus sfFtpResponse_getStatus(const sfFtpResponse* ftpResponse);
 
CSFML_NETWORK_API const char* sfFtpResponse_getMessage(const sfFtpResponse* ftpResponse);
 
CSFML_NETWORK_API sfFtp* sfFtp_create(void);
 
CSFML_NETWORK_API void sfFtp_destroy(sfFtp* ftp);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_connect(sfFtp* ftp, sfIpAddress server, unsigned short port, sfTime timeout);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_loginAnonymous(sfFtp* ftp);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_login(sfFtp* ftp, const char* name, const char* password);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_disconnect(sfFtp* ftp);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_keepAlive(sfFtp* ftp);
 
CSFML_NETWORK_API sfFtpDirectoryResponse* sfFtp_getWorkingDirectory(sfFtp* ftp);
 
CSFML_NETWORK_API sfFtpListingResponse* sfFtp_getDirectoryListing(sfFtp* ftp, const char* directory);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_changeDirectory(sfFtp* ftp, const char* directory);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_parentDirectory(sfFtp* ftp);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_createDirectory(sfFtp* ftp, const char* name);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_deleteDirectory(sfFtp* ftp, const char* name);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_renameFile(sfFtp* ftp, const char* file, const char* newName);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_deleteFile(sfFtp* ftp, const char* name);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_download(sfFtp* ftp, const char* remoteFile, const char* localPath, sfFtpTransferMode mode);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_upload(sfFtp* ftp, const char* localFile, const char* remotePath, sfFtpTransferMode mode, sfBool append);
 
CSFML_NETWORK_API sfFtpResponse* sfFtp_sendCommand(sfFtp* ftp, const char* command, const char* parameter);
 
 
#endif // SFML_FTP_H