OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Attributes | Properties | List of all members
OpenSim.Framework.Monitoring.Check Class Reference

Public Member Functions

 Check (string shortName, string name, string description, string category, string container, Func< Check, bool > checkFunc, StatVerbosity verbosity)
 
bool CheckIt ()
 
virtual string ToConsoleString ()
 

Static Public Attributes

static readonly char[] DisallowedShortNameCharacters = { '.' }
 

Properties

string Category [get, set]
 Category of this stat (e.g. cache, scene, etc). More...
 
string Container [get, set]
 Containing name for this stat. FIXME: In the case of a scene, this is currently the scene name (though this leaves us with a to-be-resolved problem of non-unique region names). More...
 
Func< Check, bool > CheckFunc [get, set]
 Action used to check whether alert should go off. More...
 
string LastFailureMessage [get, set]
 Message from the last failure, if any. If there is no message or no failure then will be null. More...
 
StatVerbosity Verbosity [get, set]
 
string ShortName [get, set]
 
string Name [get, set]
 
string Description [get, set]
 

Detailed Description

Definition at line 33 of file Check.cs.

Constructor & Destructor Documentation

OpenSim.Framework.Monitoring.Check.Check ( string  shortName,
string  name,
string  description,
string  category,
string  container,
Func< Check, bool >  checkFunc,
StatVerbosity  verbosity 
)
inline

Definition at line 75 of file Check.cs.

Member Function Documentation

bool OpenSim.Framework.Monitoring.Check.CheckIt ( )
inline

Definition at line 103 of file Check.cs.

virtual string OpenSim.Framework.Monitoring.Check.ToConsoleString ( )
inlinevirtual

Definition at line 108 of file Check.cs.

Member Data Documentation

readonly char [] OpenSim.Framework.Monitoring.Check.DisallowedShortNameCharacters = { '.' }
static

Definition at line 37 of file Check.cs.

Property Documentation

string OpenSim.Framework.Monitoring.Check.Category
getset

Category of this stat (e.g. cache, scene, etc).

Definition at line 42 of file Check.cs.

Func<Check, bool> OpenSim.Framework.Monitoring.Check.CheckFunc
getset

Action used to check whether alert should go off.

Should return true if check passes. False otherwise.

Definition at line 60 of file Check.cs.

string OpenSim.Framework.Monitoring.Check.Container
getset

Containing name for this stat. FIXME: In the case of a scene, this is currently the scene name (though this leaves us with a to-be-resolved problem of non-unique region names).

The container.

Definition at line 52 of file Check.cs.

string OpenSim.Framework.Monitoring.Check.Description
getset

Definition at line 73 of file Check.cs.

string OpenSim.Framework.Monitoring.Check.LastFailureMessage
getset

Message from the last failure, if any. If there is no message or no failure then will be null.

Should be set by the CheckFunc when applicable.

Definition at line 68 of file Check.cs.

string OpenSim.Framework.Monitoring.Check.Name
getset

Definition at line 72 of file Check.cs.

string OpenSim.Framework.Monitoring.Check.ShortName
getset

Definition at line 71 of file Check.cs.

StatVerbosity OpenSim.Framework.Monitoring.Check.Verbosity
getset

Definition at line 70 of file Check.cs.


The documentation for this class was generated from the following file: