Ricky Kwon / FTPClient

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   FTPClient_example FTP_TESTClient

Embed: (wiki syntax)

« Back to documentation index

FTPClient Class Reference
Public Member Functions

FTPClient Class Reference

FTPClient class. More...

#include <FTPClient.h>

Public Member Functions

 FTPClient (PinName mosi, PinName miso, PinName sclk, PinName ssel, const char *root)
 Create FTPClient instance.
bool open (char *ip, int port, char *id, char *pass)
 Connect to FTPServer.
bool getfile (char *myfilename, char *filename)
 Get file from FTPServer.
bool putfile (char *myfilename, char *filename)
 Put file to FTPServer.
bool dir ()
 View FTPServer directory.
bool ls ()
 View FTPServer directory.
bool fdelete (char *filename)
 Delete FTPServer file.
bool mkdir (char *dirname)
 Make FTPServer directory.
bool cd (char *dirname)
 Change current FTPServer directory.
bool quit ()
 Disconnect from FTPServer.

Detailed Description

FTPClient class.

Used file transfer with FTPServer like ALFTP(http://software.altools.co.kr/ko-kr/closed.html) This test was completed in ALFTP

Definition at line 10 of file FTPClient.h.

Constructor & Destructor Documentation

FTPClient ( PinName  mosi,
PinName  miso,
PinName  sclk,
PinName  ssel,
const char *  root 
)

Create FTPClient instance.

Definition at line 5 of file FTPClient.cpp.

Member Function Documentation

bool cd ( char *  dirname )

Change current FTPServer directory.

Parameters:
FTPServerdirectory name
Returns:
1 on success, 0 on mkdir error

Definition at line 351 of file FTPClient.cpp.

bool dir (  )

View FTPServer directory.

Parameters:
@returns1 on success, 0 on dir error

Definition at line 191 of file FTPClient.cpp.

bool fdelete ( char *  filename )

Delete FTPServer file.

Parameters:
FTPServerfile name
Returns:
1 on success, 0 on delete error

Definition at line 299 of file FTPClient.cpp.

bool getfile ( char *  myfilename,
char *  filename 
)

Get file from FTPServer.

Parameters:
Myfile name, FTPServer file name
Returns:
1 on success, 0 on getfile error

Definition at line 61 of file FTPClient.cpp.

bool ls (  )

View FTPServer directory.

Parameters:
@returns1 on success, 0 on ls error

Definition at line 245 of file FTPClient.cpp.

bool mkdir ( char *  dirname )

Make FTPServer directory.

Parameters:
FTPServerdirectory name
Returns:
1 on success, 0 on mkdir error

Definition at line 325 of file FTPClient.cpp.

bool open ( char *  ip,
int  port,
char *  id,
char *  pass 
)

Connect to FTPServer.

Parameters:
FTPServerIP, FTPServer PORT, FTPServer login ID, FTPServer login PASS
Returns:
1 on success, 0 on open error

Definition at line 16 of file FTPClient.cpp.

bool putfile ( char *  myfilename,
char *  filename 
)

Put file to FTPServer.

Parameters:
Myfile name, FTPServer file name
Returns:
1 on success, 0 on putfile error

Definition at line 129 of file FTPClient.cpp.

bool quit (  )

Disconnect from FTPServer.

Parameters:
@returns1 on success, 0 on Disconnect error

Definition at line 377 of file FTPClient.cpp.

Generated on Sat Jul 23 2022 03:17:03 by  doxygen 1.7.2