Daiki Kato
FTP client library for mbed-os
FTPClient Class Reference
#include <FTPClient.h>
Public Member Functions | |
| FTPClient (NetworkInterface *net, const char *root) | |
| Constructor. | |
| bool | open (const char *ip_addr, int port, const char *user, const char *pass) |
| Opens address. | |
| bool | quit () |
| Exits from FTP. | |
| bool | get (const char *file_name) |
| Get file from the remote computer. | |
| bool | put (const char *file_name) |
| Send one file. | |
| bool | del (const char *file_name) |
| Deletes a file. | |
| bool | mkdir (const char *dir_name) |
| Make directory. | |
| bool | cd (const char *dir_name) |
| Changes directory. | |
| bool | dir (char *list_buf, int buf_size) |
| Lists files, if connected. | |
| bool | ls (char *list_buf, int buf_size) |
| Lists files of the remotely connected computer. | |
Detailed Description
FTPClient class.
Definition at line 23 of file FTPClient.h.
Constructor & Destructor Documentation
| FTPClient | ( | NetworkInterface * | net, |
| const char * | root | ||
| ) |
Constructor.
- Parameters:
-
net FTP server port root User name
Definition at line 30 of file FTPClient.cpp.
Member Function Documentation
| bool cd | ( | const char * | dir_name ) |
Changes directory.
- Parameters:
-
dir_name Directory name
- Returns:
- true = success, false = failure
Definition at line 267 of file FTPClient.cpp.
| bool del | ( | const char * | file_name ) |
Deletes a file.
- Parameters:
-
file_name File name
- Returns:
- true = success, false = failure
Definition at line 227 of file FTPClient.cpp.
| bool dir | ( | char * | list_buf, |
| int | buf_size | ||
| ) |
Lists files, if connected.
- Parameters:
-
list_buf Buffer to store results buf_size Size of list_buf
- Returns:
- true = success, false = failure
Definition at line 287 of file FTPClient.cpp.
| bool get | ( | const char * | file_name ) |
Get file from the remote computer.
- Parameters:
-
file_name File name
- Returns:
- true = success, false = failure
Definition at line 120 of file FTPClient.cpp.
| bool ls | ( | char * | list_buf, |
| int | buf_size | ||
| ) |
Lists files of the remotely connected computer.
- Parameters:
-
list_buf Buffer to store results buf_size Size of list_buf
- Returns:
- true = success, false = failure
Definition at line 347 of file FTPClient.cpp.
| bool mkdir | ( | const char * | dir_name ) |
Make directory.
- Parameters:
-
dir_name Directory name
- Returns:
- true = success, false = failure
Definition at line 247 of file FTPClient.cpp.
| bool open | ( | const char * | ip_addr, |
| int | port, | ||
| const char * | user, | ||
| const char * | pass | ||
| ) |
Opens address.
- Parameters:
-
ip_addr FTP server IP address port FTP server port user User name pass Password
- Returns:
- true = success, false = failure
Definition at line 42 of file FTPClient.cpp.
| bool put | ( | const char * | file_name ) |
Send one file.
- Parameters:
-
file_name File name
- Returns:
- true = success, false = failure
Definition at line 170 of file FTPClient.cpp.
| bool quit | ( | ) |
Exits from FTP.
- Returns:
- true = success, false = failure
Definition at line 97 of file FTPClient.cpp.
Generated on Thu Jul 14 2022 08:33:19 by
1.7.2