|
Ftp
|
Represents a FTP session.
Inheritance Hierarchy
Namespace: GSF.Net.Ftp
Assembly: GSF.Net (in GSF.Net.dll) Version: 2.4.207-beta
Syntax[ToolboxBitmapAttribute(typeof(FtpClient))] [DefaultPropertyAttribute("Server")] [DefaultEventAttribute("FileTransferProgress")] public class FtpClient : Component
The FtpClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FtpClient | Constructs a new FTP session using the default settings. |
| FtpClient(Boolean) | Constructs a new FTP session using the specified settings. |
| FtpClient(IContainer) | Initializes a new instance of the FtpClient class. |
Properties| Name | Description | |
|---|---|---|
 | ActiveAddress | Gets or sets the IP address to send with the PORT command. |
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| CaseInsensitive | Gets or sets FTP case sensitivity of file and directory names. |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| ControlChannel | Gets the current FTP control channel. |
| CurrentDirectory | Gets or sets current FTP session directory. |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| IsBusy | Returns true if FTP session is currently busy. |
| IsConnected | Returns true if FTP session is currently connected. |
| MaxActivePort | Gets or sets the maximum value in the range of ports used when listening for connections in active mode. |
| MinActivePort | Gets or sets the minimum value in the range of ports used when listening for connections in active mode. |
| Passive | Gets or sets the passive/active mode of the server. |
| Port | Gets or sets FTP server port to use, defaults to 21. |
| RootDirectory | Gets FTP session root directory entry. |
| Server | Gets or sets FTP server name (DNS name or IP). |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| Timeout | Gets or sets the timeout, in milliseconds, for read and write operations, defaults to 30 seconds. |
| WaitLockTimeout | Gets or sets maximum number of seconds to wait for read lock for files to be uploaded. Defaults to 10 seconds. |
Methods| Name | Description | |
|---|---|---|
| AbortTransfer | Aborts current file transfer. |
| Close | Closes current FTP session. |
| Connect | Connects to FTP server using specified credentials. |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the FtpClient object and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean)) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetService | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| SetCurrentDirectory | Changes the current FTP session directory to the specified path. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
Events| Name | Description | |
|---|---|---|
 | BeginFileTransfer | Raised when file transfer begins. |
| CommandSent | Raised when FTP command has been sent. |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| EndFileTransfer | Raised when file transfer completes. |
| FileTransferNotification | Raised when asynchronous file transfer process has completed (success or failure). |
| FileTransferProgress | Raised as file transfer is progressing. |
| ResponseReceived | Raised when FTP response has been received. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
Remarks
Creates a client connection to an FTP server for uploading or downloading files.
See Also