34 #ifndef _QORE_QOREFTPCLIENT_H
36 #define _QORE_QOREFTPCLIENT_H
38 #define DEFAULT_FTP_CONTROL_PORT 21
39 #define DEFAULT_FTP_DATA_PORT 20
41 #define DEFAULT_USERNAME "anonymous"
42 #define DEFAULT_PASSWORD "qore@nohost.com"
71 struct qore_ftp_private *
priv;
130 DLLEXPORT
int put(
const char *localpath,
const char *remotename,
ExceptionSink *xsink);
142 DLLEXPORT
int get(
const char *remotepath,
const char *localname,
ExceptionSink *xsink);
307 DLLEXPORT
const char*
getMode()
const;
312 DLLEXPORT
void clearStats();
336 #endif // _QORE_OBJECTS_FTPCLIENT_H
DLLLOCAL void setControlEventQueue(Queue *cbq, ExceptionSink *xsink)
sets the event queue for the control socket
DLLEXPORT int mkdir(const char *remotepath, ExceptionSink *xsink)
creates a directory on the remote server
struct qore_ftp_private * priv
private implementation of the object
Definition: QoreFtpClient.h:71
DLLEXPORT QoreStringNode * list(const char *path, bool long_list, ExceptionSink *xsink)
returns a string listing the directory contents on the remote host (caller owns the reference count r...
DLLEXPORT void setModeEPSV()
sets the connection mode for the next connection to "EPSV" (extended passive mode) ...
DLLEXPORT int disconnect()
disconnects from the remote host if connected
This is the hash or associative list container type in Qore, dynamically allocated only...
Definition: QoreHashNode.h:49
DLLEXPORT int setInsecure()
unsets the secure connection parameter flag (to use the FTP protocol)
DLLEXPORT QoreFtpClient()
creates the object with no connection parameters
DLLEXPORT BinaryNode * getAsBinary(const char *remotepath, ExceptionSink *xsink)
gets a file from the remote server and returns it as a binary node
DLLEXPORT ~QoreFtpClient()
disconnects from the host if necessary and frees all memory associated with the object ...
DLLEXPORT QoreStringNode * getAsString(const char *remotepath, ExceptionSink *xsink)
gets a file from the remote server and returns it as a string
DLLEXPORT void setPassword(const char *p)
sets the password connection parameter
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:55
DLLEXPORT void setModeAuto()
sets the connection mode for the next connection to "auto"
size_t qore_size_t
used for sizes (same range as a pointer)
Definition: common.h:71
provides thread-safe access to FTP servers through Qore data structures
Definition: QoreFtpClient.h:68
DLLEXPORT bool isSecure() const
returns the secure connection parameter flag
DLLEXPORT QoreStringNode * pwd(ExceptionSink *xsink)
returns the working directory on the remote host (caller owns the reference count returned) ...
DLLEXPORT long verifyPeerCertificate() const
returns the peer certificate verification code
DLLEXPORT int putData(const void *data, qore_size_t len, const char *remotename, ExceptionSink *xsink)
sends a file data io the remote server
Qore's string type supported by the QoreEncoding class.
Definition: QoreString.h:82
Qore's string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
DLLEXPORT QoreStringNode * getURL() const
returns a URL string representing the current connection parameters, caller owns the reference count ...
DLLLOCAL void setDataEventQueue(Queue *cbq, ExceptionSink *xsink)
sets the event queue for the data socket
DLLEXPORT const char * getMode() const
returns a string for the connection mode: "port", "pasv", "epsv", or "auto" if not connected and auto...
DLLEXPORT void setHostName(const char *h)
sets the host name connection parameter
DLLEXPORT int del(const char *file, ExceptionSink *xsink)
deletes the given file on the remote server
DLLEXPORT int connect(ExceptionSink *xsink)
connects to the remote host and logs in
DLLLOCAL QoreFtpClient & operator=(const QoreFtpClient &)
this function is not implemented; it is here as a private function in order to prohibit it from being...
DLLEXPORT void setModePASV()
sets the connection mode for the next connection to "PASV" (passive mode)
DLLEXPORT int getPort() const
returns the port number connection parameter
DLLEXPORT int setInsecureData()
sets the secure data connection parameter flag
DLLEXPORT int rename(const char *from, const char *to, ExceptionSink *xsink)
renames/moves a file on the remote server
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:43
DLLLOCAL void setTimeout(int timeout_ms)
sets the socket I/O timeout value in milliseconds
DLLEXPORT const char * getHostName() const
returns the hostname connection parameter
DLLEXPORT const char * getUserName() const
returns the user name connection parameter
DLLEXPORT void setPort(int p)
sets the port connection parameter
long long int64
64bit integer type, cannot use int64_t here since it breaks the API on some 64-bit systems due to equ...
Definition: common.h:228
DLLEXPORT void setModePORT()
sets the connection mode for the next connection to "PORT"
DLLLOCAL int getTimeout() const
returns the socket I/O timeout value as an integer in milliseconds
DLLEXPORT const char * getPassword() const
returns the password connection parameter
DLLEXPORT void setURL(const QoreString *url, ExceptionSink *xsink)
sets the connection parameters from a URL
DLLEXPORT const char * getSSLCipherVersion() const
returns the version string of the SSL Cipher for the currently-connected control connection, or 0 if there is none
DLLEXPORT bool isDataSecure() const
returns the secure data connection parameter flag
DLLEXPORT void setUserName(const char *u)
sets the user name connection parameter
DLLLOCAL void setEventQueue(Queue *cbq, ExceptionSink *xsink)
sets the same event queue for data and control sockets
DLLEXPORT int put(const char *localpath, const char *remotename, ExceptionSink *xsink)
sends a file from the local filesystem to the remote server
DLLEXPORT int setSecure()
sets the secure connection parameter flag (to use the FTPS protocol)
DLLEXPORT int rmdir(const char *remotepath, ExceptionSink *xsink)
removes a directory on the remote server
DLLEXPORT int cwd(const char *dir, ExceptionSink *xsink)
changes the working directory on the remote host
holds arbitrary binary data
Definition: BinaryNode.h:41
DLLEXPORT const char * getSSLCipherName() const
returns the name of the SSL Cipher for the currently-connected control connection, or 0 if there is none