Notifiers Class

A class that loads all Notifier adapters.

Inheritance Hierarchy

SystemObject
GSF.AdaptersAdapterLoaderINotifier
GSF.Historian.NotifiersNotifiers

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

Syntax

C++

JavaScript

Copy

public class Notifiers : AdapterLoader<INotifier>

Public Class Notifiers
	Inherits AdapterLoader(Of INotifier)

public ref class Notifiers : public AdapterLoader<INotifier^>

type Notifiers = 
    class
        inherit AdapterLoader<INotifier>
    end

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

Type.createClass(
	'GSF.Historian.Notifiers.Notifiers',
	GSF.Adapters.AdapterLoader`1);

View Source

The Notifiers type exposes the following members.

Constructors

	Name	Description
	Notifiers	Initializes a new instance of the Notifiers class

Top

Properties

	Name	Description
	AdapterDirectory	Gets or sets the directory where Adapters are located. (Inherited from AdapterLoaderT)
	AdapterFileExtension	Gets or sets the file extension of the Adapters. (Inherited from AdapterLoaderT)
	AdapterFileFormat	Gets or sets the file format of the Adapters. (Inherited from AdapterLoaderT)
	Adapters	Gets a list of adapters loaded from the AdapterDirectory. (Inherited from AdapterLoaderT)
	AdapterWatcher	Gets the FileSystemWatcher object watching for new adapter assemblies added at runtime. (Inherited from AdapterLoaderT)
	AllowableAdapterMemoryUsage	Gets or sets the memory in megabytes the Adapters are allowed to use before being flagged as offending by the internal monitoring process. (Inherited from AdapterLoaderT)
	AllowableAdapterProcessorUsage	Gets or sets the processor time in % the Adapters are allowed to use before being flagged as offending by the internal monitoring process. (Inherited from AdapterLoaderT)
	AllowableProcessMemoryUsage	Gets or sets the memory in megabytes the current process is allowed to use before the internal monitoring process starts looking for offending Adapters. (Inherited from AdapterLoaderT)
	AllowableProcessProcessorUsage	Gets or sets the processor time in % the current process is allowed to use before the internal monitoring process starts looking for offending Adapters. (Inherited from AdapterLoaderT)
	Enabled	Gets or sets a boolean value that indicates whether the AdapterLoaderT is currently enabled. (Inherited from AdapterLoaderT)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterLoaderT)
	IsolateAdapters	Gets or sets a boolean value that indicates whether Adapters are loaded in separate AppDomain for isolated execution. (Inherited from AdapterLoaderT)
	MonitorAdapters	Gets or sets a boolean value that indicates whether resource utilization of Adapters executing in isolation is to be monitored. (Inherited from AdapterLoaderT)
	Name	Gets the unique identifier of the AdapterLoaderT. (Inherited from AdapterLoaderT)
	OperationQueue	Gets the ProcessQueueT object to be used for queuing operations to be executed on Adapters. (Inherited from AdapterLoaderT)
	PersistSettings	Gets or sets a boolean value that indicates whether AdapterLoaderT settings are to be saved to the config file. (Inherited from AdapterLoaderT)
	SettingsCategory	Gets or sets the category under which AdapterLoaderT settings are to be saved to the config file if the PersistSettings property is set to true. (Inherited from AdapterLoaderT)
	Status	Gets the descriptive status of the AdapterLoaderT. (Inherited from AdapterLoaderT)
	WatchForAdapters	Gets or sets a boolean value that indicates whether the AdapterDirectory is to be monitored for new Adapters. (Inherited from AdapterLoaderT)

Top

Methods

	Name	Description
	Dispose	Releases all the resources used by the AdapterLoaderT. (Inherited from AdapterLoaderT)
	Dispose(Boolean)	Releases the unmanaged resources used by the AdapterLoaderT and optionally releases the managed resources. (Inherited from AdapterLoaderT)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteAdapterOperation	Executes Notify(String, String, String, NotificationTypes) on the specified notifier adapter. (Overrides AdapterLoaderTExecuteAdapterOperation(T, Object))
	Finalize	Releases the unmanaged resources before the AdapterLoaderT is reclaimed by GC. (Inherited from AdapterLoaderT)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetMemoryUsage	Gets the memory usage in bytes of the specified process. (Inherited from AdapterLoaderT)
	GetProcessorUsage	Gets the % processor usage of the specified process. (Inherited from AdapterLoaderT)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initializes the AdapterLoaderT. (Inherited from AdapterLoaderT)
	Initialize(IEnumerableType)	Initializes the AdapterLoaderT. (Inherited from AdapterLoaderT)
	LoadSettings	Loads saved AdapterLoaderT settings from the config file if the PersistSettings property is set to true. (Inherited from AdapterLoaderT)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MonitorAdapterResources	Monitors the resource utilization of Adapters. (Inherited from AdapterLoaderT)
	OnAdapterCreated	Raises the AdapterCreated event. (Inherited from AdapterLoaderT)
	OnAdapterLoaded	Raises the AdapterLoaded event. (Inherited from AdapterLoaderT)
	OnAdapterLoadException	Raises the AdapterLoadException event. (Inherited from AdapterLoaderT)
	OnAdapterResourceUsageExceeded	Raises the AdapterResourceUsageExceeded event. (Inherited from AdapterLoaderT)
	OnAdapterUnloaded	Raises the AdapterUnloaded event. (Inherited from AdapterLoaderT)
	OnOperationExecutionException	Raises the OperationExecutionException event. (Inherited from AdapterLoaderT)
	ProcessAdapter(String)	Processes the adapterFile by deserializing it. (Inherited from AdapterLoaderT)
	ProcessAdapter(Type)	Processes the adapterType by instantiating it. (Inherited from AdapterLoaderT)
	SaveSettings	Saves AdapterLoaderT settings to the config file if the PersistSettings property is set to true. (Inherited from AdapterLoaderT)
	SendNotification(String, String, NotificationTypes)	Sends a notification.
	SendNotification(String, String, String, NotificationTypes)	Sends a notification.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	AdapterCreated	Occurs when a new adapter is found and instantiated. (Inherited from AdapterLoaderT)
	AdapterLoaded	Occurs when a new adapter is loaded to the Adapters list. (Inherited from AdapterLoaderT)
	AdapterLoadException	Occurs when an Exception is encountered when loading an adapter. (Inherited from AdapterLoaderT)
	AdapterResourceUsageExceeded	Occurs when an adapter has exceeded either the AllowableAdapterMemoryUsage or AllowableAdapterProcessorUsage. (Inherited from AdapterLoaderT)
	AdapterUnloaded	Occurs when an existing adapter is unloaded from the Adapters list. (Inherited from AdapterLoaderT)
	Disposed	Occurs when the class has been disposed. (Inherited from AdapterLoaderT)
	OperationExecutionException	Occurs when an Exception is encountered while executing a queued operation on one the Adapters. (Inherited from AdapterLoaderT)

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

INotifier