An NDoc Documented Class Library

ExFTPConnection Members

ExFTPConnection overview

Public Instance Constructors

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

Public Instance Properties

AccountInfo (inherited from FTPConnection)Account information string.
ActivePortRange (inherited from FTPConnection) Specifies the range of ports to be used for data-channels in active mode.
AutoLogin (inherited from FTPConnection)Determines if the component will automatically log in upon connection.
AutoPassiveIPSubstitution (inherited from FTPConnection) Use AutoPassiveIPSubstitution to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
BuildTimestamp (inherited from FTPConnection)The assembly's build timestamp.
CacheListings 
CloseStreamsAfterTransfer Determines if transfer-methods taking Streams as arguments should close the stream once the transfer is completed.
CommandEncoding The character-encoding to use when dealing with file- and directory-paths.
CompressionPreferred Flag to enable or disable MODE Z compression for FTP/FTPS transfers.
ConnectMode (inherited from FTPConnection) The connection-mode (passive or active) of data-channels.
Container (inherited from Component) Gets the IContainer that contains the Component.
DataEncoding The character-encoding to use for transferring data in ASCII mode.
DefaultSyncRules Rules that are used during synchronization operations when no other rules are specified.
DeleteOnFailure Controls whether or not a file is deleted when a failure occurs.
DetectTransferMode Determines whether the transfer mode in operations involving multiple files is automatically changed between ASCII and binary as appropriate.
DirectoryEmptyMessages (inherited from FTPConnection) Holds fragments of server messages that indicate a directory is empty.
EventsEnabled (inherited from FTPConnection)Determines whether or not events are currently enabled.
FileInfoParser (inherited from FTPConnection) Override the chosen file factory with a user created one - meaning that a specific parser has been selected
FileNotFoundMessages (inherited from FTPConnection) Holds fragments of server messages that indicate a file was not found
FilePathEncoding (inherited from FTPConnection)Obsolete. The character-encoding to use when dealing with file- and directory-paths.
IntegrityCheckTransfers Control integrity checking after file transfers.
IsConnected (inherited from FTPConnection) Indicates whether the FTP client is currently connected with the server.
IsTransferring Indicates whether or not a synchronous or asynchronous transfer is currently under way.
KeepAliveIdle Flag to enable the use of keep alive messages, which are sent to keep the connection alive when no activity is occurring.
KeepAlivePeriodSecs Period (in seconds) at which the client contacts the server so that the connection doesn't time out.
KeepAliveTransfer Flag to enable the use of keep alive messages during data transfers.
LastTransferCancelled (inherited from FTPConnection) Indicates whether or not the most recent transfer was cancelled.
LastValidReply (inherited from FTPConnection)The latest valid reply from the server.
LicenseKey The license key string.
LicenseOwner The license owner string.
LocalDirectory (inherited from FTPConnection) The working directory on the local file-system into which files are downloaded.
MaxTransferRate The maximum transfer rate in bytes per sec. Set to -1 or 0 to indicate no limiting should be applied.
MultiTransferCountBeforeSleep Number of transfers before "sleeping" during multiple FTP/FTPS data transfers.
MultiTransferSleepEnabled Determines whether or not "sleeping" is enabled during multiple FTP/FTPS data transfers.
MultiTransferSleepTime Number of seconds spent "sleeping" during multiple FTP/FTPS data transfers.
ParsingCulture (inherited from FTPConnection)The culture for parsing file listings.
PasswordPassword of account on the server.
Protocol Type of file transfer to use.
ProxySettings Settings for using proxies.
PublicIPAddress (inherited from FTPConnection) IP address of the client as the server sees it.
RetryCount Number of times to retry a failing file-transfer before giving up.
RetryDelay Milliseconds to wait for before retrying a failing file-transfer (if RetryCount>0).
ServerAddress The domain-name or IP address of the FTP server.
ServerDirectory (inherited from FTPConnection) The initial/current working directory on the server.
ServerPort The port on the server to which to connect the control-channel.
ShowHiddenFiles (inherited from FTPConnection) Include hidden files in operations that involve listing of directories, and if supported by the server (FTP and FTPS).
Site (inherited from Component) Gets or sets the ISite of the Component.
SocksProxySettingsObsolete. Settings for SOCKS proxy.
StrictReturnCodes (inherited from FTPConnection)Controls whether or not checking of return codes is strict.
TimeDifference (inherited from FTPConnection) [FTP/FTPS Only] Time difference between server and client (relative to client).
TimeIncludesSeconds (inherited from FTPConnection) [FTP/FTPS Only] Indicates whether seconds were included in the most recent directoy listing.
Timeout (inherited from FTPConnection) TCP timeout (in milliseconds) of the underlying sockets (0 means none).
TransferBufferSize The size of the buffers used in writing to and reading from the TCP sockets.
TransferCompleteMessages (inherited from FTPConnection) 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.
TransferType (inherited from FTPConnection)The current file transfer type (BINARY or ASCII).
UseGuiThreadIfAvailable (inherited from FTPConnection)Determines whether or not event-handlers will be run on the GUI thread if one is available.
UserName (inherited from FTPConnection)User-name of account on the server.
Version (inherited from FTPConnection)The version of the assembly.
WelcomeMessage (inherited from FTPConnection) Server's welcome message.
WorkingDirectory (inherited from FTPConnection)Obsolete. The current working directory on the server.

Public Instance Methods

CancelResume (inherited from FTPConnection)Cancel the resume.
CancelTransferCancels the current transfer.
ChangeWorkingDirectory Changes the working directory.
ChangeWorkingDirectoryUp Changes to the parent of the current working directory on the server.
ClearDirectoryCacheOverloaded. Clears the directory cache completely.
Close (inherited from FTPConnection)Overloaded. Close the FTP connection.
ConnectConnect to the FTP server and (if AutoLogin is set) log into the server.
CreateDirectoryCreate the specified remote directory.
CreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
DeleteDirectoryDelete the specified remote directory.
DeleteDirectoryTree Delete this entire remote directory and its contents recursively, including all subdirectories.
DeleteFileDelete the specified remote file.
DeleteMultipleFilesOverloaded. Delete all the files in the supplied remote directory (and optionally its subdirectories) that match the supplied filter.
DirectoryExists Tests if the given directory exists.
Dispose (inherited from Component)Overloaded. Releases all resources used by the Component.
DownloadByteArrayDownload data from the FTP server and return it as a byte-array.
DownloadDirectory Downloads the remote directory (and its subdirectories) to the local directory.
DownloadFileOverloaded. Download a file from the FTP server and save it locally.
DownloadMultipleOverloaded. Get multiple files into the specified local directory from the current remote directory
DownloadStreamDownload a file from the FTP server and write it to the given stream.
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.
GetCommandHelpGet the help text for the specified FTP command.
GetFeaturesGet the server supplied features.
GetFileInfosOverloaded. Returns the given directory's contents as an array of FTPFile objects.
GetFilesOverloaded. List the given directory's contents as an array of strings of file-names or full file details.
GetHashCode (inherited from FTPConnection) Returns hash-code for this connection.
GetLastWriteTimeGet modification time for a remote file.
GetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetSize Get the size of a remote file.
GetSystemTypeGet the type of the operating system at the server.
GetType (inherited from Object) Gets the Type of the current instance.
GetURL (inherited from FTPConnection)Overloaded. Returns a URL corresponding to the current state of this SecureFTPConnection. The URL optionally includes the directory, user-name and password.
GetWorkingDirectoryObsolete. Returns the working directory on the server.
InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
InvokeFTPCommand Invokes the given literal FTP command on the server.
InvokeSiteCommand Invokes the given site command on the server.
LoginLog into an account on the FTP server using UserName and Password.
PostLogin Called after the user has been successfully logged in.
RenameFileRename a file or directory.
ResumeTransferMake the next file transfer (upload or download) resume.
SendAccountInfo (inherited from FTPConnection) Supply account info to the FTP server.
SendPassword Supply the password for the previously supplied user-name to log into the FTP server. Must be preceeded by the SendUserName method
SendUserName Supply the user-name to log into an account on the FTP server. Must be followed by the SendPassword method.
SetLastWriteTime (inherited from FTPConnection)Set modification time for a remote file.
SynchronizeOverloaded. Synchronizes LocalDirectory on the local machine with ServerDirectory according to the synchronization rules in DefaultSyncRules.
ToString (inherited from Component) 
TransferFileFXP Transfer a file between FTP servers using FXP.
Unlock Unlock the software for use. This method should be used when a configuration file isn't available
UploadByteArrayOverloaded. Upload data to the FTP server in the current working directory. Allows appending if current file exists.
UploadDirectory Uploads the local directory (and its subdirectories) to the remote directory.
UploadFileOverloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadFile (inherited from FTPConnection)Overloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadMultipleOverloaded. Put multiple files from the specified local directory into the specified remote directory.
UploadStreamOverloaded. Upload a stream of data to the FTP server in the current working directory. Allows appending if current file exists.

Public Instance Events

BytesTransferred (inherited from FTPConnection)Occurs every time a specified number of bytes of data have been transferred.
Closed (inherited from FTPConnection)Occurs when the component has closed its connection to the server.
Closing (inherited from FTPConnection)Occurs when the component is about to close its connection to the server.
CommandSent (inherited from FTPConnection)Occurs when a command is sent to the server.
Connected (inherited from FTPConnection)Occurs when the component has connected to the server.
Connecting (inherited from FTPConnection)Occurs when the component is connecting to the server.
CreatedDirectory (inherited from FTPConnection)Occurs when a local directory has been created on the server.
CreatingDirectory (inherited from FTPConnection)Occurs when a directory is about to be created on the server.
Deleted (inherited from FTPConnection)Occurs when a file has been deleted from the server.
DeletedDirectory (inherited from FTPConnection)Occurs when a local directory has been deleted on the server.
Deleting (inherited from FTPConnection)Occurs when a file is about to be deleted from the server.
DeletingDirectory (inherited from FTPConnection)Occurs when a directory is about to be deleted on the server.
DirectoryChanged (inherited from FTPConnection)Obsolete. Occurs when the server directory has been changed.
DirectoryChanging (inherited from FTPConnection)Obsolete. Occurs when the server directory is about to be changed.
DirectoryListed (inherited from FTPConnection)Occurs when a directory listing operations is completed.
DirectoryListing (inherited from FTPConnection)Occurs when a directory listing operations is commenced.
Disposed (inherited from Component) Adds an event handler to listen to the Disposed event on the component.
Downloaded (inherited from FTPConnection)Occurs when a file has been downloaded from the server.
Downloading (inherited from FTPConnection)Occurs when a file is about to be downloaded from the server.
Error Occurs when an exception is thrown during an asynchronous operation.
LocalDirectoryChanged (inherited from FTPConnection)Occurs when the local directory has been changed.
LocalDirectoryChanging (inherited from FTPConnection)Occurs when the local directory is about to be changed.
LoggedIn (inherited from FTPConnection)Occurs when the component has logged in.
LoggingIn (inherited from FTPConnection)Occurs when the component is about to log in.
PropertiesCleared Occurs when properties are cleared via ClearProperties.
PropertiesLoaded Occurs when properties are loaded from a file.
PropertiesSaved Occurs when properties are saved to a file.
PropertyChanged (inherited from FTPConnection)Occurs when a property is changed.
RenamedFile (inherited from FTPConnection)Occurs when a remote file has been renamed.
RenamingFile (inherited from FTPConnection)Occurs when a remote file is about to be renamed.
ReplyReceived (inherited from FTPConnection)Occurs when a reply is received from the server.
ServerDirectoryChanged (inherited from FTPConnection)Occurs when the server directory has been changed.
ServerDirectoryChanging (inherited from FTPConnection)Occurs when the server directory is about to be changed.
Synchronized Triggered when synchronization actions have been completed.
Synchronizing Triggered before synchronization actions are begun.
SynchronizingFile Triggered when a decision is being made on how to synchronize a particular file (i.e. transfer, delete or skip).
Uploaded (inherited from FTPConnection)Occurs when a file has been uploaded to the server.
Uploading (inherited from FTPConnection)Occurs when a file is about to be uploaded to the server.

Protected Instance Constructors

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

Protected Instance Fields

accountInfoStr (inherited from FTPConnection)Account information string, for use in FTP/FTPS with the ACCT command.
areEventsEnabled (inherited from FTPConnection)Determines if events will be fired.
clientLock (inherited from FTPConnection) Used for locking connection.
compressionPreferred_ Is compression preferred?
fileTransferType (inherited from FTPConnection)Record of the transfer type - make the default ASCII.
ftpClient (inherited from FTPConnection)Instance of FTPClient.
ftpType (inherited from FTPConnection)Protocol used.
httpClient Reference to HttpClient which does all the HTTP work.
isTransferringData (inherited from FTPConnection)Determines if events will be fired.
key License key.
lastTransferCancel (inherited from FTPConnection) Flag indicating that the most recent transfer-operation was cancelled
loadingProperties True if properties are currently being loaded.
localDir (inherited from FTPConnection) Current local working directory.
loginPassword (inherited from FTPConnection)Password to log in with.
loginUserName (inherited from FTPConnection)User-name to log in with.
owner License owner.
remoteDir (inherited from FTPConnection) Current remote working directory.
useAutoLogin (inherited from FTPConnection)Determines if the components will automatically log in upon connection.
useGuiThread (inherited from FTPConnection) Flag indicating whether or not event-handlers will run on the GUI thread if one is available.

Protected Instance Properties

DesignMode (inherited from Component) Gets a value that indicates whether the Component is currently in design mode.
Events (inherited from Component) Gets the list of event handlers that are attached to this Component.

Protected Instance Methods

CheckFTPType (inherited from FTPConnection) Checks the FTP type and throws an exception if it's incorrect.
DisposeOverloaded. Close the connection if it is open.
Finalize (inherited from Component) Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetService (inherited from Component) Returns an object that represents a service provided by the Component or by its Container.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnBytesTransferred (inherited from FTPConnection) Called every time a specified number of bytes of data have been transferred.
OnChangedLocalDirectory (inherited from FTPConnection) Called when the local directory has been changed.
OnChangedServerDirectory (inherited from FTPConnection) Called when the server directory has been changed.
OnChangingLocalDirectory (inherited from FTPConnection) Called when the local directory is about to be changed.
OnChangingServerDirectory (inherited from FTPConnection) Called when the server directory is about to be changed.
OnClosed (inherited from FTPConnection) Called when a connection has closed.
OnClosing Stop the keep-alive thread then call base.
OnConnected Call base then start the keep-alive thread.
OnConnecting (inherited from FTPConnection) Called when a connection-attempt is being made.
OnCreatedDirectory (inherited from FTPConnection) Called when a directory has been created.
OnCreatingDirectory (inherited from FTPConnection) Called when a directory is about to be created.
OnDeleted (inherited from FTPConnection) Called when a file deletion operation has completed (though it may have been cancelled).
OnDeletedDirectory (inherited from FTPConnection) Called when a directory has been deleted.
OnDeleting (inherited from FTPConnection) Called when a file is about to be deleted.
OnDeletingDirectory (inherited from FTPConnection) Called when a directory is about to be deleted.
OnDirectoryListed (inherited from FTPConnection) Called when a directory listing has been retrieved.
OnDirectoryListing (inherited from FTPConnection) Called when a directory listing is about to be retrieved.
OnDownloaded (inherited from FTPConnection)Overloaded. Called when a file downloading operation has completed (though it may have been cancelled).
OnDownloading (inherited from FTPConnection)Overloaded. Called when a file is about to be downloaded.
OnLoggedIn (inherited from FTPConnection) Called when the client has logged in.
OnLoggingIn (inherited from FTPConnection) Called when the client is about to log in.
OnPropertyChanged Called when a property has been changed.
OnProxySettingsChanged Called when one of the properties of ProxySettings has changed.
OnRenamed (inherited from FTPConnection) Called when a file has been renamed.
OnRenaming (inherited from FTPConnection) Called when a file is about to be renamed.
OnUploaded (inherited from FTPConnection)Overloaded. Called when a file uploading operation has completed (though it may have been cancelled).
OnUploading (inherited from FTPConnection)Overloaded. Called when a file is about to be uploaded.
PerformAutoLoginAttempt to log into the server if AutoLogin is on.
RelativePathToAbsolute (inherited from FTPConnection) Combines a relative path with an absolute path.
SyncDownloadFileOverloaded. INTERNAL USE ONLY
SyncDownloadMultipleOverloaded. INTERNAL USE ONLY
SyncUploadFile INTERNAL USE ONLY.
SyncUploadMultipleOverloaded. INTERNAL USE ONLY.
TestConnection Test if the connection is still alive. If not then call Close so that events occur as they should.

Protected Internal Instance Properties

ActiveClient (inherited from FTPConnection) Reference to the currently active IFileTransferClient.
ExActiveClient Reference to the currently active IExFileTransferClient.

Protected Internal Instance Methods

CheckConnection (inherited from FTPConnection) Checks if the client has connected to the server and throws an exception if it hasn't. This is only intended to be used by subclasses
ftpClient_BytesTransferred (inherited from FTPConnection) Event-handler for BytesTransferred events received from IFileTransferClients.
ftpClient_CommandSent (inherited from FTPConnection) Event-handler for CommandSent events received from IFileTransferClients.
ftpClient_ReplyReceived Remember the time so that we don't send keep-alives unnecessarily.
OnSynchronized Called after synchronization ends.
OnSynchronizing Called before synchronization begins.
OnSynchronizingFile Called when a file is about to be synchronized.
RaiseBytesTransferred (inherited from FTPConnection)Raise the BytesTransferred event.
RaiseClosed (inherited from FTPConnection)Raise the Closed event.
RaiseClosing (inherited from FTPConnection)Raise the Closing event.
RaiseCommandSent (inherited from FTPConnection)Raise the CommandSent event.
RaiseConnected (inherited from FTPConnection)Raise the Connected event.
RaiseConnecting (inherited from FTPConnection)Raise the Connecting event.
RaiseCreatedDirectory (inherited from FTPConnection)Raise the CreatedDirectory event.
RaiseCreatingDirectory (inherited from FTPConnection)Raise the CreatingDirectory event.
RaiseDeleted (inherited from FTPConnection)Raise the Deleted event.
RaiseDeletedDirectory (inherited from FTPConnection)Raise the DeletedDirectory event.
RaiseDeleting (inherited from FTPConnection)Raise the Deleting event.
RaiseDeletingDirectory (inherited from FTPConnection)Raise the DeletingDirectory event.
RaiseDirectoryChanged (inherited from FTPConnection)Raise the DirectoryChanged event.
RaiseDirectoryChanging (inherited from FTPConnection)Raise the DirectoryChanging event.
RaiseDirectoryListed (inherited from FTPConnection)Raise the DirectoryListed event.
RaiseDirectoryListing (inherited from FTPConnection)Raise the DirectoryListing event.
RaiseDownloaded (inherited from FTPConnection)Raise the Downloaded event.
RaiseDownloading (inherited from FTPConnection)Raise the Downloading event.
RaiseLocalDirectoryChanged (inherited from FTPConnection)Raise the LocalDirectoryChanged event.
RaiseLocalDirectoryChanging (inherited from FTPConnection)Raise the LocalDirectoryChanging event.
RaiseLoggedIn (inherited from FTPConnection)Raise the LoggedIn event.
RaiseLoggingIn (inherited from FTPConnection)Raise the LoggingIn event.
RaisePropertiesLoadedRaise the PropertiesLoaded event.
RaisePropertiesSavedRaise the PropertiesSaved event.
RaisePropertyChanged (inherited from FTPConnection)Raise the PropertyChanged event.
RaiseRenamedFile (inherited from FTPConnection)Raise the RenamedFile event.
RaiseRenamingFile (inherited from FTPConnection)Raise the RenamingFile event.
RaiseReplyReceived (inherited from FTPConnection)Raise the ReplyReceived event.
RaiseServerDirectoryChanged (inherited from FTPConnection)Raise the ServerDirectoryChanged event.
RaiseServerDirectoryChanging (inherited from FTPConnection)Raise the ServerDirectoryChanging event.
RaiseSynchronizedRaise the Synchronized event.
RaiseSynchronizingRaise the Synchronizing event.
RaiseSynchronizingFileRaise the SynchronizingFile event.
RaiseUploaded (inherited from FTPConnection)Raise the Uploaded event.
RaiseUploading (inherited from FTPConnection)Raise the Uploading event.

See Also

ExFTPConnection Class | EnterpriseDT.Net.Ftp Namespace