Apac Namespace Reference

Namespaces
namespace	Services
	The class responsible for handling incoming command line switches. You can either edit this class directly, or subclass it and implement OnProcessArg(string) to extract your specific args.

Classes
class	Core
	This class is a container for utilities that are used throughout the system: constants, conversions, messaging, time-related features and similar functions. More...
class	SupervisableStateChangeEventArgs
	The event arguments used to report state changes of a supervised component. More...
class	SupervisableErroredEventArgs
	The event arguments used to report state changes of a supervised component. More...
class	Exceptions
	A strongly-typed resource class, for looking up localized strings, etc. More...
interface	ISupervisable
	Defines the contract supported by all supervisable components, which include supervisors themselves. More...
class	LicensedSupervisable
	Provides the basis for supervisable components to utilize the licensing infrastructure. It contains a 'safety' feature that will release the license when the object is Disposed, but this is not fool-proof. Subclasses should ensure that ReleaseLicense() is called as appropriate (most likely during Supervisable.OnStop(). More...
class	InitializationException
	The exception that is thrown when a component has not been properly initialized. More...
class	Permissions
	Encapsulation for all of the permission names and the sets of permissions for the four roles. More...
class	ProcessIdentity
	This class provides a consistant location for applications to retrieve high-level information about a running application instance. It aggregates this information from various sources such as reflection and configuration. It is intended to provide a single source for information needed when creating auditable information, such as a message log that needs to record the initiators of the messages. More...
class	ServiceLocator
	The common access location for finding runtime references to needed system entities. More...
class	Supervisable
class	SupervisableDescription
	This is a decorator class used to hide live supervisable components from user interface agents. Those agents should use the ISupervisor interface to manage subordinates. More...
class	ApacService
class	Program
class	ProjectInstaller

Enumerations
enum class	MappingType { Sensor , Measurement , Constant }
	Indicates the type of mapping being processed. More...
enum class	EventCategory {   Unknown = 0 , System = 1 , UpperThresholdBroken = 2 , UpperThresholdNormal = 3 ,   LowerThresholdBroken = 4 , LowerThresholdNormal = 5 }
	The enumeration of all possible types of events. More...
enum class	EventSeverity {   None = 0 , Critical = 1 , Major = 2 , Minor = 3 ,   Warning = 4 , Informational = 5 }
	The set of severities that are valid for an event definition. More...
enum class	Roles { Administrator = 0x01 , User = 0x02 , Guest = 0x04 , API = 0x08 }
	The set of roles supported by the security system. More...
enum class	SupervisableState {   Unknown , New , Initializing , Initialized ,   Starting , Running , Stopping , Stopped ,   Errored , Impaired , Mixed }
	Enumerates the valid states in which a supervised component may be. More...
enum class	ThresholdBoundary { Upper , Lower }
	A service enum for specifying which boundary of a threshold is being addressed. More...

Functions
delegate void	SupervisableStateChangingHandler (ISupervisable sender, SupervisableStateChangeEventArgs args)
delegate void	SupervisableStateChangedHandler (ISupervisable sender, SupervisableStateChangeEventArgs args)
delegate void	SupervisableErroredHandler (ISupervisable sender, SupervisableErroredEventArgs args)
delegate void	SupervisableHeartbeatHandler (ISupervisable sender, EventArgs args)
delegate void	VoidVoid ()
	Delegate used to asynchronously call a void method with a void param list. More...

Enumeration Type Documentation

EventCategory

enum Apac.EventCategory

strong

The enumeration of all possible types of events.

Enumerator
Unknown	The event is of an unknown type, which should mean a configuration error of some sort.
System	The event pertains to the monitoring and management system health, not the managed system's health.
UpperThresholdBroken	The event is the result of an upper threshold breakage.
UpperThresholdNormal	The event is the result of an upper threshold normalization.
LowerThresholdBroken	The event is the result of an lower threshold breakage.
LowerThresholdNormal	The event is the result of an lower threshold normalizing.

EventSeverity

enum Apac.EventSeverity

strong

The set of severities that are valid for an event definition.

Enumerator
None	The event carries no particular severity and system function is not impacted.
Critical	System function is impacted and the event is of utmost importance.
Major	System function is impacted and the event is very important.
Minor	System function is impacted and the event is moderately important.
Warning	The event is not very important, but system function could be impacted.
Informational	The event is not important, but should be shared.

MappingType

enum Apac.MappingType

strong

Indicates the type of mapping being processed.

Enumerator
Sensor	The mapping indicates the source value comes from a sensor reading.
Measurement	The mapping indicates the source value comes from another measurement.
Constant	The mapping indicates the source value comes from the supplied constant value.

Roles

enum Apac.Roles

strong

The set of roles supported by the security system.

SupervisableState

enum Apac.SupervisableState

strong

Enumerates the valid states in which a supervised component may be.

Enumerator
Unknown	Indicates that the state of the supervisor and/or its supervisable components is unknown.
New	Indicates that the supervisor or supervisable component has been created, but no other operation has been successfully invoked.
Initializing	Inidicates that the supervisable compoennt is initializing.
Initialized	Indicates that the spervisable component has been initialized, but is not yet running.
Starting	Indicates that the supervisoable component is in the process of starting up.
Running	Indicates that all supervisable components are running (in the case of a supervisor) or that an supervisable component is running.
Stopping	Indicates that the supervisable component is in the process of stopping.
Stopped	Indicates that all supervisable components are not running (in the case of a supervisor) or that an supervisable component is not running.
Errored	Indicates that the supervisor or one of it's supervisable components has errored.
Impaired	Indicates that the supervisable component has encounter a situation where it is functioning but not optimally. Eg: perhaps a registered event handler has thrown an unhandled exception. In that case, the problem should not be catastrophic to the calling supervisable component, but it should indicate that it is wired up to a misbehaving object.
Mixed	Indicates that not all supervisable components are in the same state (ISupervisor implementations only).

ThresholdBoundary

enum Apac.ThresholdBoundary

strong

A service enum for specifying which boundary of a threshold is being addressed.

Function Documentation

VoidVoid()

delegate void Apac.VoidVoid

(

)

Delegate used to asynchronously call a void method with a void param list.