log4shib  2.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Static Public Member Functions | List of all members
log4shib::Priority Class Reference

The Priority class provides importance levels with which one can categorize log messages. More...

#include <Priority.hh>

Public Types

enum  PriorityLevel {
  EMERG = 0, FATAL = 0, ALERT = 100, CRIT = 200,
  ERROR = 300, WARN = 400, NOTICE = 500, INFO = 600,
  DEBUG = 700, NOTSET = 800
}
 Predefined Levels of Priorities. More...
 
typedef int Value
 The type of Priority Values. More...
 

Static Public Member Functions

static const std::string & getPriorityName (int priority) throw ()
 Returns the name of the given priority value. More...
 
static Value getPriorityValue (const std::string &priorityName)
 Returns the value of the given priority name. More...
 

Detailed Description

The Priority class provides importance levels with which one can categorize log messages.

Member Typedef Documentation

The type of Priority Values.

Member Enumeration Documentation

Predefined Levels of Priorities.

These correspond to the priority levels used by syslog(3).

Enumerator
EMERG 
FATAL 
ALERT 
CRIT 
ERROR 
WARN 
NOTICE 
INFO 
DEBUG 
NOTSET 

Member Function Documentation

const std::string & log4shib::Priority::getPriorityName ( int  priority)
throw (
)
static

Returns the name of the given priority value.

Currently, if the value is not one of the PriorityLevel values, the method returns the name of the largest priority smaller the given value.

Parameters
prioritythe numeric value of the priority.
Returns
a string representing the name of the priority.
Priority::Value log4shib::Priority::getPriorityValue ( const std::string &  priorityName)
static

Returns the value of the given priority name.

This can be either one of EMERG ... NOTSET or a decimal string representation of the value, e.g. '700' for DEBUG.

Parameters
priorityNamethe string containing the the of the priority
Returns
the value corresponding with the priority name
Exceptions
std::invalid_argumentif the priorityName does not correspond with a known Priority name or a number

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