edtFTPnet/Free - Open-source FTP component for .NET | Download

The FTPClient type exposes the following members.

Constructors

  NameDescription
Public methodFTPClient()()()()
Constructs an FTPClient.
Public methodFTPClient(IPAddress) Obsolete.
Constructs an FTPClient instance and connects to the FTP server.
Public methodFTPClient(String) Obsolete.
Constructs an FTPClient instance and connects to the FTP server.
Public methodFTPClient(IPAddress, Int32) Obsolete.
Constructs an FTPClient instance and connects to the FTP server.
Public methodFTPClient(String, Int32) Obsolete.
Constructs an FTPClient instance and connects to the FTP server.
Public methodFTPClient(IPAddress, Int32, Int32) Obsolete.
Constructs an FTPClient instance and connects to the FTP server.
Public methodFTPClient(String, Int32, Int32) Obsolete.
Constructs an FTPClient instance and connects to the FTP server.

Methods

  NameDescription
Protected methodAbort
Abort the current action.
Public methodAccount
Supply account information string to the server.
Public methodCancelResume
Cancel the resume. Use this method if something goes wrong and the server is left in an inconsistent state
Public methodCancelTransfer
Cancels the current transfer.
Public methodCdUp
Change the remote working directory to the parent directory.
Public methodChDir
Change the remote working directory to that supplied.
Protected methodCloseDataSocket(Stream)
Protected methodCloseDataSocket(StreamReader)
Protected methodCloseDataSocket(StreamWriter)
Public methodConnect
Connect to the FTP server.
Public methodDebugResponses
Switch debug of responses on or off
Public methodDelete
Delete the specified remote file.
Public methodDir()()()()
List current directory's contents as an array of strings of filenames.
Public methodDir(String)
List a directory's contents as an array of strings of filenames.
Public methodDir(String, Boolean)
List a directory's contents as an array of strings.
Public methodDirDetails()()()()
List the current directory's contents as an array of FTPFile objects.
Public methodDirDetails(String)
List a directory's contents as an array of FTPFile objects.
Public methodDirDetails(String, FTPFileCallback)
List a directory's contents as an array of FTPFile objects.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExists
Checks for the existence of a file on the server.
Public methodFeatures
Get the server supplied features.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGet(String)
Get data from the FTP server.
Public methodGet(Stream, String)
Get data from the FTP server, using the currently set transfer mode.
Public methodGet(String, String)
Get data from the FTP server using the currently set transfer mode.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetInputStream
Protected methodGetOutputStream
Public methodGetSystem
Get the type of the OS at the server.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHelp
Get the help text for the specified command
Public methodKillControlChannel
Public methodLogin
Login into an account on the FTP server using the user-name and password provided.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMkDir
Create the specified remote working directory.
Public methodModTime
Get modification time for a remote file.
Public methodNoOperation
Send a "no operation" message that does nothing, which can be called periodically to prevent the connection timing out.
Public methodPassword
Supplies the password for a previously supplied user-name to log into the FTP server. Must be preceeded by the User(String) method
Public methodPut(array<Byte>[]()[][], String)
Put data onto the FTP server in the current directory.
Public methodPut(Stream, String)
Put a stream of data onto the FTP server in the current directory.
Public methodPut(String, String)
Put a local file onto the FTP server in the current directory.
Public methodPut(array<Byte>[]()[][], String, Boolean)
Put data onto the FTP server in the current directory. Allows appending if current file exists.
Public methodPut(Stream, String, Boolean)
Put a stream of data onto the FTP server in the current directory. Allows appending if current file exists
Public methodPut(String, String, Boolean)
Put a local file onto the FTP server in the current directory. Allows appending if current file exists.
Public methodPwd
Get the current remote working directory.
Public methodQuit
Quit the FTP session by sending a QUIT command before closing the socket.
Public methodQuitImmediately
Quit the FTP session immediately by closing the control socket without sending the QUIT command.
Public methodQuote
Issue arbitrary ftp commands to the FTP server.
Public methodRename
Rename a file or directory.
Public methodRestart
Set the REST marker so that the next transfer doesn't start at the beginning of the remote file
Public methodResume
Make the next file transfer (put or get) resume.
Public methodResumeDownload
Make the next download resume at a specific point.
Public methodRmDir
Delete the specified remote working directory.
Public methodSetModTime
Sets the modification time of a remote file.
Public methodSite
Run a site-specific command on the server.
Public methodSize
Get the size of a remote file.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUser
Supply the user-name to log into an account on the FTP server. Must be followed by the Password(String) method. Note that Connect()()()() must be called first.
Public methodValidateTransfer
Validate that the Put() or get() was successful.
Protected methodValidateTransferOnError
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.

Fields

  NameDescription
Protected fieldlogTag
Logging tag
Protected fieldnoOperationInterval
Interval for NOOP calls during large transfers in seconds
Protected fieldthrottler
Threshold for throttling

Properties

  NameDescription
Public propertyActiveIPAddress
Force the PORT command to send a fixed IP address, used only for certain firewalls
Public propertyActivePortRange
Port range for active mode, used only if it is necessary to limit the ports to a narrow range specified in a firewall
Public propertyAutoPassiveIPSubstitution
Use AutoPassiveIPSubstitution to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
Public propertyStatic memberBuildTimestamp
The edtFTPj build timestamp.
Public propertyCloseStreamsAfterTransfer
If true then streams are closed after a transfer has completed.
Public propertyConnected
Is the client currently connected?
Public propertyConnectMode
The connection-mode (passive or active) of data-channels.
Public propertyControlEncoding
The encoding to use when dealing with file and directory paths.
Public propertyControlPort
The port on the server to which to connect the control-channel.
Public propertyDataEncoding
The encoding to use for data when transferring in ASCII mode.
Public propertyDeleteOnFailure
Controls whether or not a file is deleted when a failure occurs.
Public propertyDirectoryEmptyMessages
Holds fragments of server messages that indicate a directory is empty
Public propertyFileNotFoundMessages
Holds fragments of server messages that indicate a file was not found
Public propertyFTPFileFactory
Override the chosen file factory with a user created one - meaning that a specific parser has been selected.
Public propertyIsConnected
Indicates whether the client is currently connected with the server.
Public propertyIsResuming
Returns true if the next transfer is to be resumed (i.e. Resume()()()() has been called).
Public propertyLastBytesTransferred
The number of bytes transferred in the last transfer operation.
Public propertyLastFileTransferred
The remote name/path of the last file transferred.
Public propertyLastValidReply
The latest valid reply from the server.
Public propertyLogTag
Log tag
Public propertyParsingCulture
The culture for parsing file listings.
Public propertyRemoteHost
The domain-name or IP address of the FTP server.
Public propertyServerWakeupInterval
The interval in seconds that the server is sent a wakeup message during large transfers.
Public propertyShowHiddenFiles
Include hidden files in operations that involve listing of directories, and if supported by the server.
Public propertyStrictReturnCodes
Controls whether or not checking of return codes is strict.
Public propertySynchronizePassiveConnections
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.
Public propertyTimeDifference
Time difference between server and client (relative to client).
Public propertyTimeIncludesSeconds
Indicates whether seconds were included in the most recent directoy listing.
Public propertyTimeout
TCP timeout on the underlying sockets, in milliseconds.
Public propertyTransferBufferSize
The size of the buffers (in bytes) used in writing to and reading from the data-sockets.
Public propertyTransferCompleteMessages
Holds fragments of server messages that indicate a transfer completed.
Public propertyTransferNotifyInterval
The number of bytes transferred between each notification of the BytesTransferred event.
Public propertyTransferNotifyListings
By default the BytesTransferred event is not triggered during directory listings - this property can be used to enable this behaviour.
Public propertyTransferType
The current file transfer type (BINARY or ASCII).
Public propertyStatic memberVersion
The version of edtFTPj.
Public propertyWelcomeMessage
Server welcome message.

Events

  NameDescription
Public eventBytesTransferred
Event triggered every time TransferNotifyInterval bytes transferred.
Public eventCommandError
Occurs when there is an error while a command was being sent or a reply was being received.
Public eventCommandSent
Triggered every time a command is sent to the server.
Public eventReplyReceived
Triggered every time a reply is received from the server.
Public eventTransferComplete Obsolete.
Notifies of the completion of a transfer.
Public eventTransferCompleteEx
Notifies of the completion of a transfer, and supplies more details than TransferComplete
Public eventTransferStarted Obsolete.
Notifies of the start of a transfer.
Public eventTransferStartedEx
Notifies of the start of a transfer, and supplies more details than TransferStarted

See Also