log

Name

log -- Log a module message to the RSPD.

Synopsis

$err = $mod->log($priority, $message);

Description

This function allows your module to print messages to the RSPD's log file (such as when a configuration error has occurred). If the RSPD is running in debug mode, these messages will be printed to the console (otherwise they will be seen in the log file). The $priority parameter can be one of three values: 0, 1, or 2, correspoding with RSP_NOTE, RSP_WARN, and RSP_ERROR. These are the three different error levels of RSPD log messages.

Returns

This function returns 0 if no error occurred, and -1 otherwise. In case of error, the program will croak() with an appriopriate message.