|
Ftp
|
FTP File Watcher
Inheritance Hierarchy
Namespace: GSF.Net.Ftp
Assembly: GSF.Net (in GSF.Net.dll) Version: 2.4.181-beta
Syntax[ToolboxBitmapAttribute(typeof(FtpFileWatcher))] [DefaultPropertyAttribute("Server")] [DefaultEventAttribute("FileAdded")] public class FtpFileWatcher : Component
The FtpFileWatcher type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FtpFileWatcher | Constructs a new FTP file watcher using the default settings. |
| FtpFileWatcher(IContainer) | Initializes a new instance of the FtpFileWatcher class. |
| FtpFileWatcher(Boolean, Boolean) | Constructs a new FTP file watcher using the specified settings. |
Properties| Name | Description | |
|---|---|---|
 | 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) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Directory | Gets or sets name of FTP directory name to monitor. Leave blank to monitor initial FTP session directory. |
| Enabled | Gets or sets enabled state of the FtpFileWatcher object. |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| IsConnected | Returns true if FTP file watcher session is connected. |
| NotifyOnComplete | Sets flag for notification time. Set to true to only notify when a file is finished uploading, set to False to get an immediate notification when a new file is detected. |
| Port | Gets or sets FTP server port to use, defaults to 21. |
| Server | Gets or sets FTP server name (DNS name or IP) to watch. |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| WatchInterval | Gets or sets interval, in seconds, to scan for file changes on monitored FTP directory. |
Methods| Name | Description | |
|---|---|---|
| CloneFtpSession | Clones FTP session used by file watcher so it can be used for other purposes. |
| Close | Closes FTP session and clears resources used by the FtpFileWatcher. |
| Connect | Connects to FTP server and enables file watching if Enabled is true. |
| 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 FtpFileWatcher 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) |
| OnCommandSent | Raises CommandSent event. |
| OnFileAdded | Raises FileAdded event. |
| OnFileDeleted | Raises FileDeleted event. |
| OnResponseReceived | Raises ResponseReceived event. |
| OnStatus | Raises Status event. |
| Reset | Resets and restarts FTP session used by FTP file watcher. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
Events| Name | Description | |
|---|---|---|
 | 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) |
| FileAdded | Raised when new file is added to monitored FTP directory. |
| FileDeleted | Raised when file is deleted from monitored FTP directory. |
| ResponseReceived | Raised when FTP response has been received. |
| Status | Raised when new status messages come from the FTP file watcher. |
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
Monitors for file changes over an FTP session.
See Also