| Name | Description | |
|---|---|---|
 | AsyncFtpClient Constructor | Initializes a new instance of the AsyncFtpClient class. |
The following tables list the members exposed by AsyncFtpClient.
Public Constructors
Protected Fields
| Name | Description | |
|---|---|---|
 | m_rawExtendedFeatureCache | (Inherited from Xceed.Ftp.FtpClient) |
Public Properties
| Name | Description | |
|---|---|---|
 | ActiveSecurityOptions | (Inherited from Xceed.Ftp.FtpClient) |
| Busy | Gets a boolean value indicating if the FTP client is currently performing an FTP operation. For detailed state information, consult the FtpClient.State property. (Inherited from FtpClient) |
| Connected | Gets a boolean value indicating if the FTP client is connected to an FTP server. For detailed state information, consult the FtpClient.State property. (Inherited from FtpClient) |
| DataChannelProtection | (Inherited from FtpClient) |
| Encoding | Gets or sets the System.Text.Encoding that is used to encode commands sent to the server, and decode replies and folder listings received from the server. (Inherited from FtpClient) |
| FxpPassiveTransfer | Gets or sets a Boolean value indicating if FXP file transfers use the passive method or not to initiate the data connection. (Inherited from FtpClient) |
| HostName | Gets the host name used to connect, or an empty string if not connected. (Inherited from FtpClient) |
| KeepAliveInterval | Gets or sets the interval, in seconds, at which a NOOP command is sent on the command channel during a file transfer. (Inherited from FtpClient) |
| ListingMethod | Gets the current listing method that is used to retrieve folder contents from the FTP server. (Inherited from FtpClient) |
| ListingParsers | Gets a collection of FtpListingParser objects that are used to parse the lines returned by calls to various methods. (Inherited from FtpClient) |
| LocalAddress | Gets or sets the local IP address and port from which the FTP client is connected. (Inherited from FtpClient) |
| LocalDataAddress | Gets or sets the IP address and port of the client-side data connection to use in subsequent data connections. If FtpClient.PassiveTransfer is false, this property represents the address of the client-side listening socket waiting for the server’s data connection request. (Inherited from FtpClient) |
| PassiveTransfer | Gets or sets a boolean value indicating if the FTP client should initiate the data connection rather than the FTP server. (Inherited from FtpClient) |
| PreAllocateStorage | Gets or sets a boolean value indicating if the FTP server must reserve enough space before a file is sent. (Inherited from FtpClient) |
| Proxy | Gets or sets the proxy client to use for connecting and/or logging in via a proxy server. (Inherited from FtpClient) |
| RepresentationType | Gets or sets a value indicating how the data is transferred to and from the FTP server. (Inherited from FtpClient) |
| SendTelnetInterruptSignal | Gets or sets a value indicating if the Telnet interrupt signal should be sent before the QUIT command is sent to an FTP server, allowing an FTP server to be notified that the connection will be terminated. This property does not apply to the Compact Framework. (Inherited from FtpClient) |
| SendTypeCommand | Gets or sets a boolean value indicating if the TYPE command should be sent before initiating a file transfer. (Inherited from FtpClient) |
| ServerAddress | Gets the IP address and port to which the FTP client is connected. (Inherited from FtpClient) |
| ServerFolderSeparator | Gets or sets the FTP server's folder separator character. (Inherited from FtpClient) |
| State | Gets a value indicating the current state of the FTP client. (Inherited from FtpClient) |
| SynchronizingObject | Gets or sets the object used to automatically redirect events on the main UI thread. (Inherited from FtpClient) |
| Timeout | Gets or sets a value, in seconds, indicating after what period of time an FTP operation should timeout. (Inherited from FtpClient) |
| TraceWriter | Gets or sets the System.IO.TextWriter which will trace the connection/deconnection process as well as the commands and replies sent to and received from the FTP server. (Inherited from FtpClient) |
| TransferMode | Gets the transfer mode used to send and receive data to and from an FTP server. (Inherited from FtpClient) |
| UseRemoteAddress | Gets or sets a value indicating whether to use the remote address. (Inherited from FtpClient) |
Public Methods
| Name | Description | |
|---|---|---|
 | Abort | Aborts the current FTP command. (Inherited from Xceed.Ftp.FtpClient) |
| Authenticate | Overloaded. Authenticates and encrypts the current FTP connection. (Inherited from FtpClient) |
| BeginAbort | Begins the process of aborting the current FTP command. Don't forget to call EndAbort! |
| BeginAuthenticate | Overloaded. Begins the authentification and encryption of the current FTP connection. Don't forget to call EndAuthenticate! |
| BeginChangeCurrentFolder | Begins the process of changing the current working folder of the FTP server. Don't forget to call EndChangeCurrentFolder! |
| BeginChangeDataChannelProtection | Begins the process of changing the data channel protection. Don't forget to call EndChangeDataChannelProtection! |
| BeginChangeListingMethod | |
| BeginChangeToParentFolder | Begins the process of changing the current working folder of the FTP server to the parent folder. Don't forget to call EndChangeToParentFolder! |
| BeginChangeTransferMode | Begins the process of changing the transfer mode. Don't forget to call EndChangeTransferMode! |
| BeginChangeUser | Overloaded. Begins the process of changing the currently logged-in user to the anonymous user without disconnecting from the FTP server. Don't forget to call EndChangeUser! |
| BeginClearCommandChannel | Begins the process of clearing the command channel. Don't forget to call EndClearCommandChannel! |
| BeginConnect | Overloaded. Begins the connection process of the FTP client to an FTP server on port 21. Don't forget to call EndConnect! |
| BeginCreateFolder | Begins the process of creating a folder on the FTP server. Don't forget to call EndCreateFolder! |
| BeginDeleteFile | Begins the process of deleting a file from the FTP server. Don't forget to call EndDeleteFile! |
| BeginDeleteFolder | Overloaded. Begins the processing of deleting a folder from the FTP server. Don't forget to call EndDeleteFolder! |
| BeginDisconnect | Begins the process of disconnecting the FTP client from the FTP server to which it is connected. Don't forget to call EndDisconnect! |
 | BeginFxpCopy | Overloaded. |
| BeginGetCurrentFolder | Begins the process of retrieving the current working folder of the FTP server. Don't forget to call EndGetCurrentFolder! |
| BeginGetDownloadStream | Overloaded. Begins the process of retrieving a direct access to the readonly data stream being received. Don't forget to call EndGetDownloadStream! |
| BeginGetFolderContents | Overloaded. Begins the process of retrieving the contents of the current working folder. Don't forget to call EndGetFolderContents! |
| BeginGetRawExtendedFeatures | Begins the process retrieving a list of the extended features that are implemented by the FTP server. Don't forget to call EndGetRawExtendedFeatures! |
| BeginGetRawFolderContents | Overloaded. Begins the process of retrieving an unprocessed, clear text list representing the contents of the current working folder as sent by the FTP server and indicates if the entire listing or only filenames should be retrieved. Don't forget to call EndGetRawFolderContents! |
| BeginGetUploadStream | Overloaded. Begins the process of retrieving a direct access to the write-only data stream to send to. |
| BeginLogin | Overloaded. Begins the anonymous login process of the FTP client to the FTP server to which it is connected. Don't forget to call EndLogin! |
| BeginReceiveFile | Overloaded. Begins the process of receiving the specified file from the current working folder and stores it on the local system using the specified path and filename. Don't forget to call EndReceiveFile! |
| BeginReceiveMultipleFiles | Begins the process of retreiving the files that match the provided file mask from the current working folder and stores them on the local system in the specified folder. Don't forget to call EndReceiveMultipleFiles! |
| BeginRenameFile | Begins the process of renaming a file on the FTP server. Don't forget to call EndRenameFile! |
| BeginSendCustomCommand | Begins the process of sending a custom command to the FTP server. Don't forget to call EndSendCustomCommand! |
| BeginSendFile | Overloaded. Begins the process of sending the specified file to the FTP server's current working folder and stores it using the same filename. Don't forget to call EndSendFile! |
| BeginSendFileToUniqueName | Overloaded. Begins the process of sending the specified file to the FTP server's current working folder and stores it using a unique filename. Don't forget to call EndSendFileToUniqueName! |
| BeginSendMultipleFiles | Begins the process of sending the files that match the provided file mask to the FTP server's current working folder. Don't forget to call EndSendMultipleFiles! |
| ChangeCurrentFolder | Changes the current working folder of the FTP server. (Inherited from FtpClient) |
| ChangeDataChannelProtection | Changes the data channel protection. (Inherited from FtpClient) |
| ChangeListingMethod | Changes the current listing method that is used to retrieve folder contents from the FTP server. (Inherited from FtpClient) |
| ChangeToParentFolder | Changes the current working folder of the FTP server to the parent folder. (Inherited from FtpClient) |
| ChangeTransferMode | Changes the current transfer mode. (Inherited from FtpClient) |
| ChangeUser | Overloaded. Changes the currently logged-in user to the anonymous user without disconnecting from the FTP server. (Inherited from FtpClient) |
| ClearCommandChannel | Clears the command channel after login to facilitate firewall NAT when connecting using a secure data channel. (Inherited from FtpClient) |
| Connect | Overloaded. Connects the FTP client to an FTP server on port 21. (Inherited from FtpClient) |
| CreateFolder | Create a folder on the FTP server. (Inherited from FtpClient) |
| DeleteFile | Deletes a file from the FTP server. (Inherited from FtpClient) |
| DeleteFolder | Overloaded. Deletes a folder from the FTP server. (Inherited from FtpClient) |
| Disconnect | Disconnects the FTP client from the FTP server to which it is connected. (Inherited from FtpClient) |
| EndAbort | Ends the process of aborting the current FTP command |
| EndAuthenticate | Ends the authentification and encryption of the current FTP connection. |
| EndChangeCurrentFolder | Ends the process of changing the current working folder of the FTP server. |
| EndChangeDataChannelProtection | Ends the change of the data channel protection.. |
| EndChangeListingMethod | |
| EndChangeToParentFolder | Ends the process of changing the current working folder of the FTP server to the parent folder. |
| EndChangeTransferMode | Ends the process of changing the transfer mode. |
| EndChangeUser | Ends the process of changing the currently logged-in user. |
| EndClearCommandChannel | Ends the clearing of the command channel. |
| EndConnect | Ends the connection process of the FTP client to an FTP server. |
| EndCreateFolder | Ends the process of creating a folder on the FTP server. |
| EndDeleteFile | Ends the process of deleting a file from the FTP server. |
| EndDeleteFolder | Ends the process of deleting a folder from the FTP server. |
| EndDisconnect | Ends the process of disconnecting the FTP client from the FTP server to which it is connected. |
| EndFxpCopy | |
| EndGetCurrentFolder | Ends the process of retrieving the current working folder of the FTP server. |
| EndGetDownloadStream | Ends the process of retrieving a direct access to the readonly data stream being received. |
| EndGetFolderContents | Ends the process of retrieving the contents of the current working folder. |
| EndGetRawExtendedFeatures | Ends the process of retrieving an unprocessed, clear text list of the extended features that are implemented by an FTP server. |
| EndGetRawFolderContents | Ends the process of retrieving an unprocessed, clear text list representing the contents of the current working folder |
| EndGetUploadStream | Ends the process of retrieving a direct access to the write-only data stream to send to. |
| EndLogin | Ends the login process of the FTP client to the FTP server to which it is connected. |
| EndReceiveFile | Ends the process of receiving a file from the FTP server. |
| EndReceiveMultipleFiles | Ends the process of retreiving the files that match the provided file mask from the current working folder and stores them on the local system in the specified folder. |
| EndRenameFile | Ends the process of renaming a file on the FTP server. |
| EndSendCustomCommand | Ends the process of sending a custom command to the FTP server. |
| EndSendFile | Ends the process of sending a file to the FTP server. |
| EndSendFileToUniqueName | Ends the process of sending a file to the FTP server's current working folder and storing it using a unique filename. |
| EndSendMultipleFiles | Ends the process of sending the files that match the provided file mask to the FTP server's current working folder. |
| GetCurrentFolder | Retrieves the current working folder of the FTP server. (Inherited from FtpClient) |
| GetDownloadStream | Overloaded. Retrieves a direct access to the readonly data stream being received. (Inherited from FtpClient) |
| GetFolderContents | Overloaded. Retrieves the contents of the current working folder. (Inherited from FtpClient) |
| GetRawExtendedFeatures | Retrieves an unprocessed, clear text list of the extended features that are implemented by an FTP server. (Inherited from FtpClient) |
| GetRawFolderContents | Overloaded. Retrieves an unprocessed, clear text list representing the contents of the current working folder as sent by the FTP server and indicates if the entire listing or only filenames should be retrieved. (Inherited from FtpClient) |
| GetUploadStream | Overloaded. Retrieves a direct access to the write-only data stream to send to. (Inherited from FtpClient) |
| Login | Overloaded. Login the FTP client anonymously to the FTP server to which it is connected. (Inherited from FtpClient) |
| ReceiveFile | Overloaded. Receives the specified file from the current working folder and stores it on the local system using the specified path and filename. (Inherited from FtpClient) |
| ReceiveMultipleFiles | Receives the files that match the provided file mask from the current working folder and stores them on the local system in the specified folder. (Inherited from FtpClient) |
| RenameFile | Renames a file or, if supported, a folder on the FTP server. (Inherited from FtpClient) |
| SendCustomCommand | Sends a custom command to the FTP server. (Inherited from FtpClient) |
| SendFile | Overloaded. Sends the specified file to the FTP server's current working folder and stores it using the same filename. (Inherited from FtpClient) |
| SendFileToUniqueName | Overloaded. Sends the specified file to the FTP server's current working folder and stores it using a unique filename. (Inherited from FtpClient) |
| SendMultipleFiles | Sends the files that match the provided file mask to the FTP server's current working folder. (Inherited from FtpClient) |
Public Events
| Name | Description | |
|---|---|---|
 | CertificateReceived | Raised when an FTP server's certificate was received and verified. (Inherited from Xceed.Ftp.FtpClient) |
| CertificateRequired | Raised when a client certificate is required by the FTP server, or the one provided (if e.Certificate is not a null reference (Nothing in Visual Basic)) was rejected. Note: This event is not available in Xceed FTP for .NET Compact Framework because this product does not support Secure FTP. (Inherited from FtpClient) |
| CommandSent | Raised once for every command sent to the FTP server. (Inherited from FtpClient) |
| Disconnected | Raised when the FtpClient.Disconnect method is called as well as when the connection is terminated by the FTP server. (Inherited from FtpClient) |
| FileTransferStatus | Raised for every 4Kb sent or received during a file transfer. (Inherited from FtpClient) |
| MultipleFileTransferError | Raised when an error occurs while transferring multiple files to or from the FTP server to determine what action should be taken. (Inherited from FtpClient) |
| ParsingListingLine | Raised when a listing line is received from the FTP server. (Inherited from FtpClient) |
| ReceivingFile | Raised for each file being received from the FTP server. (Inherited from FtpClient) |
| ReplyReceived | Raised once for each reply received from the FTP server. If a reply contains multiple lines, they will be received as a group. (Inherited from FtpClient) |
| SendingFile | Raised for each file being sent to the FTP server. (Inherited from FtpClient) |
| StateChanged | Raised when the FtpClient.State of the FTP client changes. (Inherited from FtpClient) |
See Also