An NDoc Documented Class Library

FTPClient Members

FTPClient overview

Public Static Properties

BuildTimestampThe edtFTPj build timestamp.
VersionThe version of edtFTPj.

Public Instance Constructors

FTPClient Overloaded. Initializes a new instance of the FTPClient class.

Public Instance Properties

ActiveIPAddress Force the PORT command to send a fixed IP address, used only for certain firewalls
ActivePortRange Port range for active mode, used only if it is necessary to limit the ports to a narrow range specified in a firewall
AutoPassiveIPSubstitution Use AutoPassiveIPSubstitution to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
CloseStreamsAfterTransfer If true then streams are closed after a transfer has completed.
Connected Is the client currently connected?
ConnectMode The connection-mode (passive or active) of data-channels.
ControlEncoding The encoding to use when dealing with file and directory paths.
ControlPort The port on the server to which to connect the control-channel.
DataEncoding The encoding to use for data when transferring in ASCII mode.
DeleteOnFailure Controls whether or not a file is deleted when a failure occurs.
DirectoryEmptyMessages Holds fragments of server messages that indicate a directory is empty
FileNotFoundMessages Holds fragments of server messages that indicate a file was not found
FTPFileFactory Override the chosen file factory with a user created one - meaning that a specific parser has been selected.
IsConnected Indicates whether the client is currently connected with the server.
LastBytesTransferred The number of bytes transferred in the last transfer operation.
LastFileTransferred The remote name/path of the last file transferred.
LastValidReplyThe latest valid reply from the server.
ParsingCultureThe culture for parsing file listings.
RemoteHost The domain-name or IP address of the FTP server.
ServerWakeupInterval The interval in seconds that the server is sent a wakeup message during large transfers.
ShowHiddenFiles Include hidden files in operations that involve listing of directories, and if supported by the server.
StrictReturnCodesControls whether or not checking of return codes is strict.
SynchronizePassiveConnections For cases where your FTP server does not properly manage PASV connections, it may be necessary to synchronize the creation of passive data sockets. It has been reported that some FTP servers (such as those at Akamai) appear to get confused when multiple FTP clients from the same IP address attempt to connect at the same time. For more details, please read the forum post http://www.enterprisedt.com/forums/viewtopic.php?t=2559 The default value for SynchronizePassiveConnections is false.
TimeDifference Time difference between server and client (relative to client).
TimeIncludesSeconds Indicates whether seconds were included in the most recent directoy listing.
Timeout TCP timeout on the underlying sockets, in milliseconds.
TransferBufferSize The size of the buffers (in bytes) used in writing to and reading from the data-sockets.
TransferCompleteMessages Holds fragments of server messages that indicate a transfer completed.
TransferNotifyInterval The number of bytes transferred between each notification of the BytesTransferred event.
TransferNotifyListings By default the BytesTransferred event is not triggered during directory listings - this property can be used to enable this behaviour.
TransferTypeThe current file transfer type (BINARY or ASCII).
WelcomeMessage Server welcome message.

Public Instance Methods

Account Supply account information string to the server.
CancelResume Cancel the resume. Use this method if something goes wrong and the server is left in an inconsistent state
CancelTransferCancels the current transfer.
CdUpChange the remote working directory to the parent directory.
ChDirChange the remote working directory to that supplied.
ConnectConnect to the FTP server.
DebugResponsesSwitch debug of responses on or off
DeleteDelete the specified remote file.
DirOverloaded. List a directory's contents as an array of strings of filenames.
DirDetailsOverloaded. List the current directory's contents as an array of FTPFile objects.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Exists Checks for the existence of a file on the server.
FeaturesGet the server supplied features.
GetOverloaded. Get data from the FTP server.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetSystemGet the type of the OS at the server.
GetType (inherited from Object) Gets the Type of the current instance.
Help Get the help text for the specified command
KillControlChannel 
LoginLogin into an account on the FTP server using the user-name and password provided.
MkDirCreate the specified remote working directory.
ModTimeGet modification time for a remote file.
NoOperation Send a "no operation" message that does nothing, which can be called periodically to prevent the connection timing out.
Password Supplies the password for a previously supplied user-name to log into the FTP server. Must be preceeded by the User method
PutOverloaded. Put a stream of data onto the FTP server in the current directory. Allows appending if current file exists
PwdGet the current remote working directory.
QuitQuit the FTP session by sending a QUIT command before closing the socket.
QuitImmediately Quit the FTP session immediately by closing the control socket without sending the QUIT command.
QuoteIssue arbitrary ftp commands to the FTP server.
RenameRename a file or directory.
RestartSet the REST marker so that the next transfer doesn't start at the beginning of the remote file
ResumeMake the next file transfer (put or get) resume.
RmDirDelete the specified remote working directory.
SetModTimeSets the modification time of a remote file.
SiteRun a site-specific command on the server.
Size Get the size of a remote file.
ToString (inherited from Object) Returns a String that represents the current Object.
User Supply the user-name to log into an account on the FTP server. Must be followed by the Password method. Note that Connect must be called first.
ValidateTransferValidate that the Put() or get() was successful.

Public Instance Events

BytesTransferred Event triggered every time TransferNotifyInterval bytes transferred.
CommandSent Triggered every time a command is sent to the server.
ReplyReceived Triggered every time a reply is received from the server.
TransferCompleteObsolete. Notifies of the completion of a transfer.
TransferCompleteEx Notifies of the completion of a transfer, and supplies more details than TransferComplete
TransferStartedObsolete. Notifies of the start of a transfer.
TransferStartedEx Notifies of the start of a transfer, and supplies more details than TransferStarted

Protected Instance Fields

noOperationInterval Interval for NOOP calls during large transfers in seconds
throttler Threshold for throttling

Protected Instance Methods

AbortAbort the current action.
CloseDataSocketOverloaded.  
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetInputStream 
GetOutputStream 
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
ValidateTransferOnError Validate a transfer when an error has occurred on the data channel. Set a very short transfer in case things have hung. Set it back at the end.

See Also

FTPClient Class | EnterpriseDT.Net.Ftp Namespace