INotifier Interface

Defines a notifier that can process notification messages.

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

Syntax

C++

JavaScript

Copy

public interface INotifier : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings

Public Interface INotifier
	Inherits IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, 
	IPersistSettings

public interface class INotifier : IAdapter, 
	ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings

type INotifier = 
    interface
        interface IAdapter
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
        interface IPersistSettings
    end

GSF.Historian.Notifiers.INotifier = function();
GSF.Historian.Notifiers.INotifier.createInterface('GSF.Historian.Notifiers.INotifier');

View Source

The INotifier type exposes the following members.

Properties

	Name	Description
	Domain	Gets the AppDomain in which the IAdapter is executing. (Inherited from IAdapter)
	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. (Inherited from IAdapter)
	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. (Inherited from IAdapter)
	Name	Gets the name of the object providing status information. (Inherited from IProvideStatus)
	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	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. (Inherited from IAdapter)
	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. (Inherited from IAdapter)

Top

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)
	Notify	Process a notification.
	SaveSettings	Saves settings to the config file. (Inherited from IPersistSettings)

Top

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. (Inherited from IAdapter)
	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 IAdapter wants to provide a status update. (Inherited from IAdapter)

Top

Reference

GSF.Historian.Notifiers Namespace

NotificationTypes