Qore Programming Language Reference Manual  0.8.12.3
QC_FtpClient.dox.h
1 namespace Qore {
4 
82 class FtpClient {
83 
84 public:
86 
95  clearStats();
96 
97 public:
99 
108 nothing clearWarningQueue();
109 
110 public:
112 
129 nothing connect();
130 
131 public:
133 
138  constructor();
139 
140 public:
142 
154  constructor(string url);
155 
156 public:
158 
160  copy();
161 
162 public:
164 
177 nothing cwd(string path);
178 
179 public:
181 
196 nothing del(string remote_path);
197 
198 public:
200 
208  destructor();
209 
210 public:
212 
220 nothing disconnect();
221 
222 public:
224 
248 nothing get(string remote_path, *string local_path);
249 
250 public:
252 
272 binary getAsBinary(string remote_path);
273 
274 public:
276 
296 string getAsString(string remote_path);
297 
298 public:
300 
307 *string getHostName();
308 
309 public:
311 
321 string getMode();
322 
323 public:
325 
332 *string getPassword();
333 
334 public:
336 
343 int getPort();
344 
345 public:
347 
358 *string getSSLCipherName();
359 
360 public:
362 
373 *string getSSLCipherVersion();
374 
375 public:
377 
384 int getTimeout();
385 
386 public:
388 
395 string getURL();
396 
397 public:
399 
421 
422 public:
424 
431 *string getUserName();
432 
433 public:
435 
446 bool isDataSecure();
447 
448 public:
450 
460 bool isSecure();
461 
462 public:
464 
481 *string list();
482 
483 public:
485 
504 *string list(string path);
505 
506 public:
508 
523 nothing mkdir(string remote_path);
524 
525 public:
527 
544 *string nlst();
545 
546 public:
548 
567 *string nlst(string path);
568 
569 public:
571 
594 nothing put(string local_path, *string remote_path);
595 
596 public:
598 
614 nothing putData(string data, string remote_path);
615 
616 public:
618 
634 nothing putData(binary data, string remote_path);
635 
636 public:
638 
653 string pwd();
654 
655 public:
657 
673 nothing rename(string from, string to);
674 
675 public:
677 
692 nothing rmdir(string remote_path);
693 
694 public:
696 
701 nothing setControlEventQueue();
702 
703 public:
705 
717 
718 public:
720 
725 nothing setDataEventQueue();
726 
727 public:
729 
741 
742 public:
744 
749 nothing setEventQueue();
750 
751 public:
753 
764 nothing setEventQueue(Qore::Thread::Queue queue);
765 
766 public:
768 
775 nothing setHostName(string host);
776 
777 public:
779 
786 nothing setInsecure();
787 
788 public:
790 
798 nothing setInsecureData();
799 
800 public:
802 
807 nothing setModeAuto();
808 
809 public:
811 
816 nothing setModeEPSV();
817 
818 public:
820 
825 nothing setModePASV();
826 
827 public:
829 
834 nothing setModePORT();
835 
836 public:
838 
845 nothing setPassword(string pass);
846 
847 public:
849 
858 nothing setPort(int port);
859 
860 public:
862 
871 nothing setSecure(bool secure = True);
872 
873 public:
875 
879  setTimeout(timeout timeout_ms);
880 
881 public:
883 
895 nothing setURL(string url);
896 
897 public:
899 
906 nothing setUserName(string user);
907 
908 public:
910 
942 nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms = 1s);
943 
944 public:
946 
957 *string verifyPeerCertificate();
958 };
959 };
nothing setControlEventQueue()
Clears any Queue object that may be set on the FtpClient object so that I/O events are no longer capt...
string getURL()
Retrieves the current connection URL string for this object.
copy()
Throws an exception to prevent copying of objects this class.
nothing setModeEPSV()
Sets the object to only try to make data connections using EPSV (RFC-2428 extended passive) mode...
*string nlst()
Returns a list of file names from the FTP server in the current working directory or NOTHING if the p...
nothing disconnect()
Disconnects from an FTP server.
nothing setHostName(string host)
Sets the hostname or address to use to connect to for the next connection.
nothing setModePASV()
Sets the object to only try to make data connections using PASV (RFC-959 passive) mode...
setTimeout(timeout timeout_ms)
sets the socket I/O timeout value in milliseconds
const True
logical True
Definition: qc_qore.dox.h:94
nothing setSecure(bool secure=True)
Make an FTPS connection to the server on the next connect if the argument is True.
*string getSSLCipherVersion()
Returns the version of the cipher for an encrypted connection or NOTHING if an encrypted connection i...
binary binary()
Always returns an empty binary object (of zero length)
The FtpClient class allows Qore code to communicate with FTP servers with the FTP and FTPS protocols...
Definition: QC_FtpClient.dox.h:82
*string getSSLCipherName()
Returns the name of the cipher for an encrypted connection or NOTHING if an encrypted connection is n...
int getTimeout()
returns the socket I/O timeout value as an integer in milliseconds
nothing rmdir(string remote_path)
Removes a directory on the remote FTP server; if any errors occur, an exception is thrown...
nothing clearWarningQueue()
Removes any warning Queue object from the Socket.
nothing setEventQueue()
Clears any Queue object that may be set on the FtpClient object so that I/O events are no longer capt...
nothing connect()
Connects to the FTP server and attempts a login; if any errors occur, an exception is thrown...
nothing setModePORT()
Sets the object to only try to make data connections using PORT mode.
string pwd()
Returns the server-side current working directory.
*string list()
Returns a list of files from the FTP server in the server's long format in the current working direct...
clearStats()
Clears performance statistics.
*string verifyPeerCertificate()
Returns a string code giving the result of verifying the remote certificate or NOTHING if an encrypte...
string getMode()
returns a string for the connection mode: "port", "pasv", "epsv", or "auto" if not connected and auto...
*string getPassword()
Returns the current password value or NOTHING if none is set.
nothing setUserName(string user)
Sets the user name to use for the next connection.
nothing setURL(string url)
Sets the connection and login parameters based on the URL passed as an argument.
binary getAsBinary(string remote_path)
Gets a file from the FTP server and returns it as a binary.
hash getUsageInfo()
Returns performance statistics for the socket.
nothing setPassword(string pass)
Sets the password to use for the next connection.
int getPort()
Retrieves the current connection port value for this object.
nothing mkdir(string remote_path)
Creates a directory on the FTP server; if any errors occur, an exception is thrown.
bool isSecure()
Returns True if the control connection is a secure TLS/SSL connection, False if not.
nothing setPort(int port)
Sets the control port value to use for the next connection (the FTP protocol default is 21) ...
string getAsString(string remote_path)
Gets a file from the FTP server and returns it as a string.
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:15
destructor()
Disconnects any remote connection and destroys the object.
nothing setModeAuto()
Sets the object to automatically try to negotiate the data connections in EPSV, PASV, and PORT modes, in that order.
nothing putData(string data, string remote_path)
Transfers string data to the FTP server and saves it as a file on the remote machine; if any errors o...
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:2
constructor()
Creates an empty FtpClient object.
hash hash(object obj)
Returns a hash of an object's members.
nothing setInsecureData()
Make a non-encrypted data connection to the server on the next connect even if the control connection...
*string getHostName()
Returns the current hostname value or NOTHING if none is set.
nothing setDataEventQueue()
Clears any Queue object that may be set on the FtpClient object so that I/O events are no longer capt...
bool isDataSecure()
Returns True if the data connections are secure TLS/SSL connections, False if not.
nothing cwd(string path)
Changes the current working directory on the server.
nothing del(string remote_path)
Deletes a file from the FTP server; if any errors occur, an exception is thrown.
nothing rename(string from, string to)
Renames/moves a file or directory; if any errors occur, an exception is thrown.
nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms=1s)
Sets a Queue object to receive socket warnings.
nothing put(string local_path, *string remote_path)
Transfers a local file to the FTP server; if any errors occur, an exception is thrown.
nothing setInsecure()
Make a non-encrypted connection to the server on the next connect.
*string getUserName()
Returns the current username value or NOTHING if none is set.