|
IAdapter Interface |
Defines an adapter that could execute in isolation in a separate AppDomain.
Namespace: GSF.Adapters
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntaxpublic interface IAdapter : ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings
The IAdapter type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Domain | Gets the AppDomain in which the IAdapter is executing. |
| Enabled |
Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle) |
| HostFile | Gets or sets the path to the file where the IAdapter is housed. |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle) |
| MemoryUsage | Gets the memory utilization of the IAdapter in bytes if executing in a separate AppDomain, otherwise NaN. |
| Name |
Gets the name of the object providing status information.
(Inherited from IProvideStatus) |
| PersistSettings |
Determines whether the object settings are to be persisted to the config file.
(Inherited from IPersistSettings) |
| ProcessorUsage | Gets the % processor utilization of the IAdapter if executing in a separate AppDomain otherwise NaN. |
| SettingsCategory |
Gets or sets the category name under which the object settings are persisted in the config file.
(Inherited from IPersistSettings) |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| TypeName | Gets or sets the text representation of the IAdapter's TypeName. |
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Initialize |
Initializes the state of the object.
(Inherited from ISupportLifecycle) |
| LoadSettings |
Loads saved settings from the config file.
(Inherited from IPersistSettings) |
| SaveSettings |
Saves settings to the config file.
(Inherited from IPersistSettings) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle) |
| ExecutionException | Occurs when the IAdapter encounters an Exception during execution. |
| StatusUpdate | Occurs when the IAdapter wants to provide a status update. |
See Also