|
Ftp
|
Represents an virtual FTP session for the specified target FtpType.
Inheritance Hierarchy
Namespace: GSF.Net.VirtualFtpClient
Assembly: GSF.Net (in GSF.Net.dll) Version: 2.4.181-beta
Syntaxpublic class FtpClient : IDisposable
The FtpClient type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | ActiveAddress | Gets or sets the IP address to send with the PORT command. |
| CaseSensitive | Gets or sets FTP case sensitivity of file and directory names. |
| CurrentDirectory | Gets or sets current FTP session directory. |
| FtpType | Gets FtpType for this FtpClient. |
| 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 for FTP and 69 for TFTP. |
| RootDirectory | Gets FTP session root directory entry. |
| Server | Gets or sets FTP server name (DNS name or IP). |
| TFtpDirectoryFile | Gets or sets the directory file, e.g., DIR.TXT, associated with TFTP connections. |
| Timeout | Gets or sets the timeout, in milliseconds, for read and write operations, defaults to 30 seconds. |
Methods| Name | Description | |
|---|---|---|
 | Connect | Connects to FTP server using specified credentials. |
| Dispose | Releases all the resources used by the FtpClient object. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the FtpClient object and optionally releases the managed resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SetCurrentDirectory | Changes the current FTP session directory to the specified path. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | BeginFileTransfer | Raised when file transfer begins. |
| CommandSent | Raised when FTP command has been sent. |
| Disposed | Raised when class is disposed; |
| EndFileTransfer | Raised when file transfer completes. |
| FileTransferNotification | Raised when file transfer process has completed (success or failure). |
| FileTransferProgress | Raised as file transfer is progressing. |
| ResponseReceived | Raised when FTP response has been received. |
Fields| Name | Description | |
|---|---|---|
  | DefaultCaseSensitive | Defines the default value for the CaseSensitive property. |
| DefaultPassive | Defines the default value for the Passive property. |
| DefaultTFtpDirectoryFile | Defines the default value for the TFtpDirectoryFile property. |
| DefaultTimeout | Defines the default value for the Timeout property. |
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) |
See Also