NotifierBase Class

Base class for a notifier that can process notification messages.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    GSF.AdaptersAdapter
      GSF.Historian.NotifiersNotifierBase
        GSF.Historian.NotifiersEmailNotifier

Namespace: GSF.Historian.Notifiers
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public abstract class NotifierBase : Adapter, 
	INotifier, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, 
	IPersistSettings

Public MustInherit Class NotifierBase
	Inherits Adapter
	Implements INotifier, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus, IPersistSettings

public ref class NotifierBase abstract : public Adapter, 
	INotifier, IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, 
	IPersistSettings

[<AbstractClassAttribute>]
type NotifierBase = 
    class
        inherit Adapter
        interface INotifier
        interface IAdapter
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
        interface IPersistSettings
    end

GSF.Historian.Notifiers.NotifierBase = function();

Type.createClass(
	'GSF.Historian.Notifiers.NotifierBase',
	GSF.Adapters.Adapter,
	GSF.Historian.Notifiers.INotifier,
	GSF.Adapters.IAdapter,
	GSF.ISupportLifecycle,
	IDisposable,
	GSF.IProvideStatus,
	GSF.Configuration.IPersistSettings);

View Source

The NotifierBase type exposes the following members.

Constructors

	Name	Description
	NotifierBase	Initializes a new instance of the notifier.

Top

Properties

	Name	Description
	Domain	Gets the AppDomain in which the Adapter is executing. (Inherited from Adapter)
	Enabled	Gets or sets a boolean value that indicates whether the Adapter is currently enabled. (Inherited from Adapter)
	HostFile	Gets or sets the path to the file where the Adapter is housed. (Inherited from Adapter)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from Adapter)
	MemoryUsage	Gets the memory utilization of the Adapter in bytes if executing in a separate AppDomain, otherwise NaN. (Inherited from Adapter)
	Name	Gets the unique identifier of the Adapter. (Inherited from Adapter)
	NotifyOptions	Gets or set NotificationTypes that can be processed by the notifier.
	NotifyTimeout	Gets or sets the number of seconds to wait for Notify(String, String, String, NotificationTypes) to complete.
	PersistSettings	Gets or sets a boolean value that indicates whether Adapter settings are to be saved to the config file. (Inherited from Adapter)
	ProcessorUsage	Gets the % processor utilization of the Adapter if executing in a separate AppDomain otherwise NaN. (Inherited from Adapter)
	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. (Inherited from Adapter)
	Status	Gets the descriptive status of the Adapter. (Inherited from Adapter)
	TypeName	Gets or sets the text representation of the Adapter's TypeName. (Inherited from Adapter)

Top

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. (Inherited from Adapter)
	Dispose(Boolean)	Releases the unmanaged resources used by the notifier and optionally releases the managed resources. (Overrides AdapterDispose(Boolean))
	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. (Inherited from Adapter)
	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. (Inherited from Adapter)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	LoadSettings	Loads saved notifier settings from the config file if the PersistSettings property is set to true. (Overrides AdapterLoadSettings)
	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)
	Notify	Process a notification.
	NotifyAlarm	When overridden in a derived class, processes a Alarm notification.
	NotifyHeartbeat	When overridden in a derived class, processes a Heartbeat notification.
	NotifyInformation	When overridden in a derived class, processes a Information notification.
	NotifyWarning	When overridden in a derived class, processes a Warning notification.
	OnDisposed	Raises the Disposed event. (Inherited from Adapter)
	OnExecutionException	Raises the ExecutionException event. (Inherited from Adapter)
	OnNotificationSendComplete	Raises the NotificationSendComplete event.
	OnNotificationSendException	Raises the NotificationSendException event.
	OnNotificationSendStart	Raises the NotificationSendStart event.
	OnNotificationSendTimeout	Raises the NotificationSendTimeout event.
	OnStatusUpdate	Raises the StatusUpdate event. (Inherited from Adapter)
	SaveSettings	Saves notifier settings to the config file if the PersistSettings property is set to true. (Overrides AdapterSaveSettings)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	Disposed	Occurs when Adapter is disposed. (Inherited from Adapter)
	ExecutionException	Occurs when the IAdapter encounters an Exception during execution. (Inherited from Adapter)
	NotificationSendComplete	Occurs when a notification has been sent.
	NotificationSendException	Occurs when an Exception is encountered while sending a notification.
	NotificationSendStart	Occurs when a notification is being sent.
	NotificationSendTimeout	Occurs when a timeout is encountered while sending a notification.
	StatusUpdate	Occurs when the Adapter wants to provide a status update. (Inherited from Adapter)

Top

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)

Top

Reference

GSF.Historian.Notifiers Namespace