|
Adapter Class |
Represents an adapter that could execute in isolation in a separate AppDomain.
Inheritance Hierarchy
Namespace: GSF.Adapters
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax[SerializableAttribute] [DataContractAttribute(Namespace = "")] public class Adapter : MarshalByRefObject, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings
The Adapter type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Domain | Gets the AppDomain in which the Adapter is executing. |
| Enabled | Gets or sets a boolean value that indicates whether the Adapter is currently enabled. |
| HostFile | Gets or sets the path to the file where the Adapter is housed. |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. |
| MemoryUsage | Gets the memory utilization of the Adapter in bytes if executing in a separate AppDomain, otherwise NaN. |
| Name | Gets the unique identifier of the Adapter. |
| PersistSettings | Gets or sets a boolean value that indicates whether Adapter settings are to be saved to the config file. |
| ProcessorUsage | Gets the % processor utilization of the Adapter if executing in a separate AppDomain otherwise NaN. |
| SettingsCategory | Gets or sets the category under which Adapter settings are to be saved to the config file if the PersistSettings property is set to true. |
| Status | Gets the descriptive status of the Adapter. |
| TypeName | Gets or sets the text representation of the Adapter's TypeName. |
Methods| Name | Description | |
|---|---|---|
 | 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 the resources used by the Adapter. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the Adapter and optionally releases the managed resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the Adapter is reclaimed by GC.
(Overrides ObjectFinalize) |
| 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) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | Initializes the Adapter. |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadSettings | Loads saved Adapter settings from the config file if the PersistSettings property is set to true. |
| 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) |
| OnDisposed | Raises the Disposed event. |
| OnExecutionException | Raises the ExecutionException event. |
| OnStatusUpdate | Raises the StatusUpdate event. |
| SaveSettings | Saves Adapter settings to the config file if the PersistSettings property is set to true. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when Adapter is disposed. |
| ExecutionException | Occurs when the IAdapter encounters an Exception during execution. |
| StatusUpdate | Occurs when the Adapter wants to provide a status update. |
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 AlsoInheritance Hierarchy