Click or drag to resize

Adapter Class

Represents an adapter that could execute in isolation in a separate AppDomain.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    GSF.AdaptersAdapter
      More

Namespace: GSF.Adapters
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax

The Adapter type exposes the following members.

Constructors
 NameDescription
Public methodAdapter Initializes a new instance of the Adapter.
Top
Properties
 NameDescription
Public propertyDomain Gets the AppDomain in which the Adapter is executing.
Public propertyEnabled Gets or sets a boolean value that indicates whether the Adapter is currently enabled.
Public propertyHostFile Gets or sets the path to the file where the Adapter is housed.
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
Public propertyMemoryUsage Gets the memory utilization of the Adapter in bytes if executing in a separate AppDomain, otherwise NaN.
Public propertyName Gets the unique identifier of the Adapter.
Public propertyPersistSettings Gets or sets a boolean value that indicates whether Adapter settings are to be saved to the config file.
Public propertyProcessorUsage Gets the % processor utilization of the Adapter if executing in a separate AppDomain otherwise NaN.
Public propertySettingsCategory 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.
Public propertyStatus Gets the descriptive status of the Adapter.
Public propertyTypeName Gets or sets the text representation of the Adapter's TypeName.
Top
Methods
 NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Public methodDispose Releases all the resources used by the Adapter.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the Adapter and optionally releases the managed resources.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Releases the unmanaged resources before the Adapter is reclaimed by GC.
(Overrides ObjectFinalize)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitialize Initializes the Adapter.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public methodLoadSettings Loads saved Adapter settings from the config file if the PersistSettings property is set to true.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected methodOnDisposed Raises the Disposed event.
Protected methodOnExecutionException Raises the ExecutionException event.
Protected methodOnStatusUpdate Raises the StatusUpdate event.
Public methodSaveSettings Saves Adapter settings to the config file if the PersistSettings property is set to true.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventDisposed Occurs when Adapter is disposed.
Public eventExecutionException Occurs when the IAdapter encounters an Exception during execution.
Public eventStatusUpdate Occurs when the Adapter wants to provide a status update.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also
Inheritance Hierarchy