Qore Programming Language Reference Manual 0.8.10

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

All Classes Namespaces Functions Variables Groups Pages
QC_FtpClient.dox.h
1 namespace Qore {
4
76 class FtpClient {
77
78 public:
80
89 clearStats();
90
91 public:
93
102 nothing clearWarningQueue();
103
104 public:
106
123 nothing connect();
124
125 public:
127
132 constructor();
133
134 public:
136
148 constructor(string url);
149
150 public:
152
154 copy();
155
156 public:
158
171 nothing cwd(string path);
172
173 public:
175
190 nothing del(string remote_path);
191
192 public:
194
202 destructor();
203
204 public:
206
214 nothing disconnect();
215
216 public:
218
240 nothing get(string remote_path, *string local_path);
241
242 public:
244
264 binary getAsBinary(string remote_path);
265
266 public:
268
288 string getAsString(string remote_path);
289
290 public:
292
299 *string getHostName();
300
301 public:
303
310 *string getPassword();
311
312 public:
314
321 int getPort();
322
323 public:
325
336 *string getSSLCipherName();
337
338 public:
340
351 *string getSSLCipherVersion();
352
353 public:
355
362 string getURL();
363
364 public:
366
387 hash getUsageInfo();
388
389 public:
391
398 *string getUserName();
399
400 public:
402
413 bool isDataSecure();
414
415 public:
417
427 bool isSecure();
428
429 public:
431
448 *string list();
449
450 public:
452
471 *string list(string path);
472
473 public:
475
490 nothing mkdir(string remote_path);
491
492 public:
494
511 *string nlst();
512
513 public:
515
534 *string nlst(string path);
535
536 public:
538
561 nothing put(string local_path, *string remote_path);
562
563 public:
565
581 nothing putData(string data, string remote_path);
582
583 public:
585
601 nothing putData(binary data, string remote_path);
602
603 public:
605
620 string pwd();
621
622 public:
624
640 nothing rename(string from, string to);
641
642 public:
644
659 nothing rmdir(string remote_path);
660
661 public:
663
668 nothing setControlEventQueue();
669
670 public:
672
683 nothing setControlEventQueue(Qore::Thread::Queue queue);
684
685 public:
687
692 nothing setDataEventQueue();
693
694 public:
696
707 nothing setDataEventQueue(Qore::Thread::Queue queue);
708
709 public:
711
716 nothing setEventQueue();
717
718 public:
720
731 nothing setEventQueue(Qore::Thread::Queue queue);
732
733 public:
735
742 nothing setHostName(string host);
743
744 public:
746
753 nothing setInsecure();
754
755 public:
757
765 nothing setInsecureData();
766
767 public:
769
774 nothing setModeAuto();
775
776 public:
778
783 nothing setModeEPSV();
784
785 public:
787
792 nothing setModePASV();
793
794 public:
796
801 nothing setModePORT();
802
803 public:
805
812 nothing setPassword(string pass);
813
814 public:
816
825 nothing setPort(int port);
826
827 public:
829
838 nothing setSecure(bool secure = True);
839
840 public:
842
854 nothing setURL(string url);
855
856 public:
858
865 nothing setUserName(string user);
866
867 public:
869
899 nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms = 1s);
900
901 public:
903
914 *string verifyPeerCertificate();
915 };
916 };
Qore::FtpClient::setControlEventQueue
nothing setControlEventQueue()
Clears any Queue object that may be set on the FtpClient object so that I/O events are no longer capt...
Qore::FtpClient::getURL
string getURL()
Retrieves the current connection URL string for this object.
Qore::FtpClient::copy
copy()
Throws an exception to prevent copying of objects this class.
Qore::FtpClient::setModeEPSV
nothing setModeEPSV()
Sets the object to only try to make data connections using EPSV (RFC-2428 extended passive) mode...
Qore::FtpClient::nlst
*string nlst()
Returns a list of file names from the FTP server in the current working directory or NOTHING if the p...
Qore::FtpClient::disconnect
nothing disconnect()
Disconnects from an FTP server.
Qore::FtpClient::setHostName
nothing setHostName(string host)
Sets the hostname or address to use to connect to for the next connection.
Qore::FtpClient::setModePASV
nothing setModePASV()
Sets the object to only try to make data connections using PASV (RFC-959 passive) mode...
Qore::True
const True
logical True
Definition: qc_qore.dox.h:94
Qore::FtpClient::setSecure
nothing setSecure(bool secure=True)
Make an FTPS connection to the server on the next connect if the argument is True.
Qore::FtpClient::getSSLCipherVersion
*string getSSLCipherVersion()
Returns the version of the cipher for an encrypted connection or NOTHING if an encrypted connection i...
Qore::binary
binary binary()
Always returns an empty binary object (of zero length)
Qore::FtpClient
The FtpClient class allows Qore code to communicate with FTP servers with the FTP and FTPS protocols...
Definition: QC_FtpClient.dox.h:76
Qore::FtpClient::getSSLCipherName
*string getSSLCipherName()
Returns the name of the cipher for an encrypted connection or NOTHING if an encrypted connection is n...
Qore::FtpClient::rmdir
nothing rmdir(string remote_path)
Removes a directory on the remote FTP server; if any errors occur, an exception is thrown...
Qore::FtpClient::clearWarningQueue
nothing clearWarningQueue()
Removes any warning Queue object from the Socket.
Qore::FtpClient::setEventQueue
nothing setEventQueue()
Clears any Queue object that may be set on the FtpClient object so that I/O events are no longer capt...
Qore::FtpClient::connect
nothing connect()
Connects to the FTP server and attempts a login; if any errors occur, an exception is thrown...
Qore::FtpClient::setModePORT
nothing setModePORT()
Sets the object to only try to make data connections using PORT mode.
Qore::FtpClient::pwd
string pwd()
Returns the server-side current working directory.
Qore::FtpClient::list
*string list()
Returns a list of files from the FTP server in the server&#39;s long format in the current working direct...
Qore::FtpClient::clearStats
clearStats()
Clears performance statistics.
Qore::FtpClient::verifyPeerCertificate
*string verifyPeerCertificate()
Returns a string code giving the result of verifying the remote certificate or NOTHING if an encrypte...
Qore::FtpClient::getPassword
*string getPassword()
Returns the current password value or NOTHING if none is set.
Qore::FtpClient::setUserName
nothing setUserName(string user)
Sets the user name to use for the next connection.
Qore::FtpClient::setURL
nothing setURL(string url)
Sets the connection and login parameters based on the URL passed as an argument.
Qore::FtpClient::getAsBinary
binary getAsBinary(string remote_path)
Gets a file from the FTP server and returns it as a binary.
Qore::FtpClient::getUsageInfo
hash getUsageInfo()
Returns performance statistics for the socket.
Qore::FtpClient::setPassword
nothing setPassword(string pass)
Sets the password to use for the next connection.
Qore::FtpClient::getPort
int getPort()
Retrieves the current connection port value for this object.
Qore::FtpClient::mkdir
nothing mkdir(string remote_path)
Creates a directory on the FTP server; if any errors occur, an exception is thrown.
Qore::FtpClient::isSecure
bool isSecure()
Returns True if the control connection is a secure TLS/SSL connection, False if not.
Qore::FtpClient::setPort
nothing setPort(int port)
Sets the control port value to use for the next connection (the FTP protocol default is 21) ...
Qore::FtpClient::getAsString
string getAsString(string remote_path)
Gets a file from the FTP server and returns it as a string.
Qore::Thread::Queue
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:13
Qore::FtpClient::destructor
destructor()
Disconnects any remote connection and destroys the object.
Qore::FtpClient::setModeAuto
nothing setModeAuto()
Sets the object to automatically try to negotiate the data connections in EPSV, PASV, and PORT modes, in that order.
Qore::FtpClient::putData
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...
Qore::FtpClient::constructor
constructor()
Creates an empty FtpClient object.
Qore::hash
hash hash(object obj)
Returns a hash of an object&#39;s members.
Qore::FtpClient::setInsecureData
nothing setInsecureData()
Make a non-encrypted data connection to the server on the next connect even if the control connection...
Qore::FtpClient::getHostName
*string getHostName()
Returns the current hostname value or NOTHING if none is set.
Qore::FtpClient::setDataEventQueue
nothing setDataEventQueue()
Clears any Queue object that may be set on the FtpClient object so that I/O events are no longer capt...
Qore::FtpClient::isDataSecure
bool isDataSecure()
Returns True if the data connections are secure TLS/SSL connections, False if not.
Qore::FtpClient::cwd
nothing cwd(string path)
Changes the current working directory on the server.
Qore::FtpClient::del
nothing del(string remote_path)
Deletes a file from the FTP server; if any errors occur, an exception is thrown.
Qore::FtpClient::rename
nothing rename(string from, string to)
Renames/moves a file or directory; if any errors occur, an exception is thrown.
Qore::FtpClient::setWarningQueue
nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms=1s)
Sets a Queue object to receive socket warnings.
Qore::FtpClient::put
nothing put(string local_path, *string remote_path)
Transfers a local file to the FTP server; if any errors occur, an exception is thrown.
Qore::FtpClient::setInsecure
nothing setInsecure()
Make a non-encrypted connection to the server on the next connect.
Qore::FtpClient::getUserName
*string getUserName()
Returns the current username value or NOTHING if none is set.