File 'base/syslog.tcl' (part of 'Pool_Base')

Description (short): syslog-like logging facility.
Written by: Andreas Kupries
Description: General logging facility to avoid having lower libraries to know the actual log mechanism employed by a client application.
Depends on: Tcl
Keywords: logging, syslog, message reporting, error reporting, message levels

::pool::syslog::2color (level)
::pool::syslog::Log2Stderr (level text)
::pool::syslog::def (putsCmd)
::pool::syslog::defLevel (level putsCmd)
::pool::syslog::levelCmp (lvA lvB)
::pool::syslog::levels ()
::pool::syslog::logLevel (o v)
::pool::syslog::setStderr ()
::pool::syslog::syslog (level args)

::pool::syslog::2color (level)

Argument: level The level to convert into a color.

Returns: The color associated to the given level

::pool::syslog::Log2Stderr (level text)

Standard log procedure, writes incoming message to stderr.

Argument: level Log level of message given.

Argument: text Message to log

::pool::syslog::def (putsCmd)

Defines a command which will be executed for every message given to the system.

Argument: putsCmd The script evaluated by ::pool::syslog::syslog to log the incoming messages. Will be called with 2 arguments: The level and the text.

::pool::syslog::defLevel (level putsCmd)

Defines a command which will be executed for every message given to the system and having the specified level.

Argument: level The level triggering the execution of putsCmd.

Argument: putsCmd The script evaluated by ::pool::syslog::syslog to log the incoming messages. Will be called with 2 arguments: The level and the text.

::pool::syslog::levelCmp (lvA lvB)

Argument: lvA The first level to compare.

Argument: lvB The second level to compare.

Returns: One of -1, 0, or 1. 0 if lvA and lvB are equal, -1 if lvA is less important than lvB and 1 else.

::pool::syslog::levels ()

Returns: Returns a list containing the names of all log-levels known to the system. The shortcuts are not returned.

::pool::syslog::logLevel (o v)

Type checker procedure for 'getopt'. Accepts all levels known to this module.

Argument: o The name of the option to check.

Argument: v The value to check.

Returns: A boolean value. True if and only if v is a level defined here.

::pool::syslog::setStderr ()

Convenience procedure. Installs the standard log procedure (::pool::syslog::Log2Stderr) for all levels.

::pool::syslog::syslog (level args)

Entrypoint to the logger facility, to be used by libraries. The actual log is done by a command defined via ::pool::syslog::def or ::pool::syslog::defLevel.

Argument: level Relative importance of the logged message. Should be one of the strings returned by ::pool::syslog::levels.

Argument: args list containing the texts to log.

Generated by AutoDoc 2.4 at 09/14/2000, invoked by Andreas Kupries

::pool::syslog::2color (level)
Argument: level	The level to convert into a color.
Returns: The color associated to the given level

::pool::syslog::Log2Stderr (level text)
Standard log procedure, writes incoming message to stderr.
Argument: level	Log level of message given.
Argument: text	Message to log

::pool::syslog::def (putsCmd)
Defines a command which will be executed for every message given to the system.
Argument: putsCmd	The script evaluated by ::pool::syslog::syslog to log the incoming messages. Will be called with 2 arguments: The level and the text.

::pool::syslog::levelCmp (lvA lvB)
Argument: lvA	The first level to compare.
Argument: lvB	The second level to compare.
Returns: One of -1, 0, or 1. 0 if lvA and lvB are equal, -1 if lvA is less important than lvB and 1 else.

::pool::syslog::levels ()
Returns: Returns a list containing the names of all log-levels known to the system. The shortcuts are not returned.

::pool::syslog::logLevel (o v)
Type checker procedure for 'getopt'. Accepts all levels known to this module.
Argument: o	The name of the option to check.
Argument: v	The value to check.
Returns: A boolean value. True if and only if v is a level defined here.

::pool::syslog::setStderr ()
Convenience procedure. Installs the standard log procedure (::pool::syslog::Log2Stderr) for all levels.

::pool::syslog::syslog (level args)
Entrypoint to the logger facility, to be used by libraries. The actual log is done by a command defined via ::pool::syslog::def or ::pool::syslog::defLevel.
Argument: level	Relative importance of the logged message. Should be one of the strings returned by ::pool::syslog::levels.
Argument: args	list containing the texts to log.