Diff: FTPClient.h

Revision:

3:4fd8e5cd6307

Parent:

1:2630b5456598

Child:

4:4bef734cc93e

--- a/FTPClient.h	Tue Jul 28 23:33:09 2015 +0000
+++ b/FTPClient.h	Wed Jul 29 00:03:21 2015 +0000
@@ -3,24 +3,97 @@
 #include "mbed.h"
 #include "SDFileSystem.h"
 #define MAX_SS              256
+/** FTPClient class.
+ *  Used file transfer with FTPServer like ALFTP(http://software.altools.co.kr/ko-kr/closed.html)
+ *  This test was completed in ALFTP
+ */
 class FTPClient{
 public:
+    /** Create FTPClient instance */
     FTPClient(PinName mosi, PinName miso, PinName sclk, PinName ssel, const char* root);
     ~FTPClient() {};
     
+    /** Connect to FTPServer
+     *
+     * @param FTPServer IP, FTPServer PORT, FTPServer login ID, FTPServer login PASS
+     * @returns
+     *   1 on success,
+     *   0 on open error
+     */
     bool open(char* ip, int port, char* id, char* pass);
+    
+    /** Get file from FTPServer
+     *
+     * @param My file name, FTPServer file name 
+     * @returns
+     *   1 on success,
+     *   0 on getfile error
+     */
     bool getfile(char* myfilename, char* filename);
+    
+    /** Put file to FTPServer
+     *
+     * @param My file name, FTPServer file name 
+     * @returns
+     *   1 on success,
+     *   0 on putfile error
+     */
     bool putfile(char* myfilename, char* filename);
+    
+    /** View FTPServer directory
+     *
+     * @param 
+     * @returns
+     *   1 on success,
+     *   0 on dir error
+     */
     bool dir();
+    
+    /** View FTPServer directory
+     *
+     * @param 
+     * @returns
+     *   1 on success,
+     *   0 on ls error
+     */
     bool ls();
+    
+    /** Delete FTPServer file
+     *
+     * @param FTPServer file name
+     * @returns
+     *   1 on success,
+     *   0 on delete error
+     */
     bool fdelete(char* filename);
+    
+    /** Make FTPServer directory
+     *
+     * @param FTPServer directory name
+     * @returns
+     *   1 on success,
+     *   0 on mkdir error
+     */
     bool mkdir(char* dirname);
+    
+    /** Change current FTPServer directory
+     *
+     * @param FTPServer directory name
+     * @returns
+     *   1 on success,
+     *   0 on mkdir error
+     */
     bool cd(char* dirname);
+    
+    /** Disconnect from FTPServer
+     *
+     * @param 
+     * @returns
+     *   1 on success,
+     *   0 on Disconnect error
+     */
     bool quit();
-    int pportc(char * arg);
-    
-
-    
+      
 private:
     TCPSocketConnection* FTPClientControlSock;
     TCPSocketConnection* FTPClientDataSock;
@@ -50,5 +123,7 @@
     int size;
     FILE *fp;
     SDFileSystem _SDFileSystem;
+    
+    int pportc(char * arg);
 };
 #endif
\ No newline at end of file