Learn about FTP Suite's architecture and operation.
There are two types of FTP operations you can perform with FTP Suite.
Smart Sequences perform an entire FTP sequence from login to logoff. They are suited for applications where transfers occur mostly under the client program's control and for transfer sequences that affect entire directories or multiple files in the same directory.
Smart Commands perform partial FTP sequences (usually one or two FTP commands) and are best suited for clients that cannot predict what FTP actions will be needed before hand or clients who need transfer files beyond the standard folder to folder transfer. Smart Commands give the developer more flexibility.
FTP Suite Architecture
| Component |
Purpose |
Access |
Open |
FTP Session Class |
Contains all developer accessible methods and storage to setup and execute FTP transfers. |
User |
No |
FTP Status Class |
Provides accessible events to allow developer to determine status of an FTP transfer. |
User |
Yes |
FTP Message Module |
Provides access to FTP Suite-generated messages to allow modification and multiple-language support. |
User |
Yes |
FTP Command Socket |
Sends FTP commands to FTP server and processes responses. |
Internal |
No |
FTP Data Socket |
Sends and receives all data between client and FTP server. |
Internal |
No |
FTP Connection Timer |
Raises Error Event if not reset within timeout period. |
Internal |
No |
FTP Parsed Dir
List Line Class |
Provides a structure for a parsed line of directory listing data. |
Internal |
No |
Directory Class |
Provides a structure for the local directory tree. |
Internal |
No |
FTP Suite Components
Smart Sequence Setup
At the minimum, a Smart Sequence needs to know how to login to the ftp server and what directory it will be working with on the ftp server. As an example, the setup to get a full directory listing from a directory off the root directory called "stuff" would consist of the following:
Dim ftp_session As New FTPSessionClass
// set FTP login info and server directory
ftp_session.SetLoginInfo("ftp.your.domiain", "user id", "password")
ftp_session.SetServerDirectoryPathName("/stuff")
// start the smart sequence
ftp_session.StartGetDirList
Since the FTP configuration properties are set to the most common settings by default, this may be all the setup required.
Note: FTP Suite 4.2.3 and later are only compatible with REALbasic 2006 Release 3 and later.
Download theFTP Suite manual for a complete overview of how to use Smart Sequences and Smart Commands.
|