An NDoc Documented Class Library

FTPConnection Members

FTPConnection overview

Public Static Properties

LogFile Name of file to which logs will be written.
LogLevel Determines the level of logs written.
LogToConsole Determines whether or not logs will be written to the console.
LogToTrace Determines whether or not logs will be written using Trace.

Protected Static Fields

DEFAULT_WORKING_DIRECTORY Default initial working directory.

Public Instance Constructors

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

Public Instance Properties

ActivePortRange Specifies the range of ports to be used for data-channels in active mode.
AutoLoginDetermines if the component will automatically log in upon connection.
AutoPassiveIPSubstitution Use AutoPassiveIPSubstitution to ensure that data-socket connections are made to the same IP address that the control socket is connected to.
BuildTimestampThe assembly's build timestamp.
CloseStreamsAfterTransfer Determines if transfer-methods taking Streams as arguments should close the stream once the transfer is completed.
CommandEncoding The character-encoding to use for FTP control commands and when dealing with file- and directory-paths.
ConnectMode 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.
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.
EventsEnabledDetermines whether or not events are currently enabled.
FileInfoParser Override the chosen file factory with a user created one - meaning that a specific parser has been selected
FileNotFoundMessages Holds fragments of server messages that indicate a file was not found
FilePathEncodingObsolete. The character-encoding to use when dealing with file- and directory-paths.
IsConnected Indicates whether the FTP client is currently connected with the server.
IsTransferring Indicates whether the FTP client is currently transferring data.
LastTransferCancelled Indicates whether or not the most recent transfer was cancelled.
LastValidReplyThe latest valid reply from the server.
LocalDirectory The working directory on the local file-system into which files are downloaded.
ParentControl Reference to Windows Forms controls (if available).
ParsingCultureThe culture for parsing file listings.
PasswordPassword of account on the server.
Protocol Type of secure FTP to use.
PublicIPAddress IP address of the client as the server sees it.
ServerAddress The domain-name or IP address of the FTP server.
ServerDirectory The initial/current working directory on the server.
ServerPort The port on the server to which to connect the control-channel.
Site 
StrictReturnCodesControls whether or not checking of return codes is strict.
TimeDifference [FTP/FTPS Only] Time difference between server and client (relative to client).
TimeIncludesSeconds [FTP/FTPS Only] Indicates whether seconds were included in the most recent directoy listing.
Timeout 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 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.
TransferTypeThe current file transfer type (BINARY or ASCII).
UseGuiThreadIfAvailableDetermines whether or not event-handlers will be run on the GUI thread if one is available.
UserNameUser-name of account on the server.
VersionThe version of the assembly.
WorkingDirectoryObsolete. The current working directory on the server.

Public Instance Methods

CancelResumeCancel the resume.
CancelTransferCancels the current transfer.
ChangeWorkingDirectory Changes the working directory.
ChangeWorkingDirectoryUp Changes to the parent of the current working directory on the server.
CloseOverloaded. 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.
DeleteFileDelete the specified remote file.
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.
DownloadFileDownload a file from the FTP server and save it locally.
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.
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.
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.
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.
LinkComponent 
LoginLog into an account on the FTP server using UserName and Password.
RenameFileRename a file or directory.
ResumeTransferMake the next file transfer (upload or download) resume.
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.
ToString (inherited from Component) 
UploadByteArrayOverloaded. Upload data to the FTP server in the current working directory. Allows appending if current file exists.
UploadFileOverloaded. Upload a local file to the FTP server in the current working directory. Allows appending if current file exists.
UploadStreamOverloaded. Upload a stream of data to the FTP server in the current working directory. Allows appending if current file exists.

Public Instance Events

BytesTransferredOccurs every time a specified number of bytes of data have been transferred.
ClosedOccurs when the component has closed its connection to the server.
ClosingOccurs when the component is about to close its connection to the server.
CommandSentOccurs when a command is sent to the server.
ConnectedOccurs when the component has connected to the server.
ConnectingOccurs when the component is connecting to the server.
CreatedDirectoryOccurs when a local directory has been created on the server.
CreatingDirectoryOccurs when a directory is about to be created on the server.
DeletedOccurs when a file has been deleted from the server.
DeletedDirectoryOccurs when a local directory has been deleted on the server.
DeletingOccurs when a file is about to be deleted from the server.
DeletingDirectoryOccurs when a directory is about to be deleted on the server.
DirectoryChangedObsolete. Occurs when the server directory has been changed.
DirectoryChangingObsolete. Occurs when the server directory is about to be changed.
DirectoryListedOccurs when a directory listing operations is completed.
DirectoryListingOccurs when a directory listing operations is commenced.
Disposed (inherited from Component) Adds an event handler to listen to the Disposed event on the component.
DownloadedOccurs when a file has been downloaded from the server.
DownloadingOccurs when a file is about to be downloaded from the server.
LocalDirectoryChangedOccurs when the local directory has been changed.
LocalDirectoryChangingOccurs when the local directory is about to be changed.
LoggedInOccurs when the component has logged in.
LoggingInOccurs when the component is about to log in.
PropertyChangedOccurs when a property is changed.
RenamedFileOccurs when a remote file has been renamed.
RenamingFileOccurs when a remote file is about to be renamed.
ReplyReceivedOccurs when a reply is received from the server.
ServerDirectoryChangedOccurs when the server directory has been changed.
ServerDirectoryChangingOccurs when the server directory is about to be changed.
UploadedOccurs when a file has been uploaded to the server.
UploadingOccurs when a file is about to be uploaded to the server.

Protected Instance Fields

areEventsEnabledDetermines if events will be fired.
currentFileSizeSize of file currently being transferred.
fileTransferTypeRecord of the transfer type - make the default ASCII.
ftpClientInstance of FTPClient.
guiControlReference to the main window.
haveQueriedForControlFlag used to remember whether or not we've tried to find the main window yet.
isTransferringDataDetermines if events will be fired.
isTransferringMultipleFlag indicating whether or not we're doing a multiple file transfer.
lastTransferCancel Flag indicating that the most recent transfer-operation was cancelled
localDir Current local working directory.
loginPasswordPassword to log in with.
loginUserNameUser-name to log in with.
remoteDir Current remote working directory.
useAutoLoginDetermines if the components will automatically log in upon connection.
useGuiThread 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

CheckConnection 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
CheckFTPType Checks the FTP type and throws and exception if it's incorrect.
DisposeOverloaded. Disconnect from the server (if connected).
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.
InvokeDelegate Invokes the given delegate.
InvokeEventHandler Invokes the given event-handler.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnBytesTransferred Called every time a specified number of bytes of data have been transferred.
OnChangedLocalDirectory Called when the local directory has been changed.
OnChangedServerDirectory Called when the server directory has been changed.
OnChangingLocalDirectory Called when the local directory is about to be changed.
OnChangingServerDirectory Called when the server directory is about to be changed.
OnClosed Called when a connection has closed.
OnClosing Called when a connection is about to close.
OnConnected Called when a connection-attempt has completed.
OnConnecting Called when a connection-attempt is being made.
OnCreatedDirectory Called when a directory has been created.
OnCreatingDirectory Called when a directory is about to be created.
OnDeleted Called when a file deletion operation has completed (though it may have been cancelled).
OnDeletedDirectory Called when a directory has been deleted.
OnDeleting Called when a file is about to be deleted.
OnDeletingDirectory Called when a directory is about to be deleted.
OnDirectoryListed Called when a directory listing has been retrieved.
OnDirectoryListing Called when a directory listing is about to be retrieved.
OnDownloadedOverloaded. Called when a file downloading operation has completed (though it may have been cancelled).
OnDownloadingOverloaded. Called when a file is about to be downloaded.
OnLoggedIn Called when the client has logged in.
OnLoggingIn Called when the client is about to log in.
OnPropertyChanged Called when a property has been changed.
OnRenamed Called when a file has been renamed.
OnRenaming Called when a file is about to be renamed.
OnUploadedOverloaded. Called when a file uploading operation has completed (though it may have been cancelled).
OnUploadingOverloaded. Called when a file is about to be uploaded.
PerformAutoLoginAttempt to log into the server if AutoLogin is on.
RelativePathToAbsolute Combines a relative path with an absolute path.

Protected Internal Instance Constructors

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

Protected Internal Instance Properties

ActiveClient Reference to the currently active IFileTransferClient.

Protected Internal Instance Methods

ftpClient_BytesTransferred Event-handler for BytesTransferred events received from IFileTransferClients.
ftpClient_TransferCompleteEx Event-handler for TransferCompleteEx events received from IFileTransferClients.
ftpClient_TransferStartedEx Event-handler for TransferStartedEx events received from IFileTransferClients.

See Also

FTPConnection Class | EnterpriseDT.Net.Ftp Namespace