20. log
FieldsMethodsMember ObjectsIteratorsIterated objects1. Fields
rule_priority
| Function name |
Function signature |
| log_rule_priority_get |
int log_rule_priority_get (object:log_rule obj) |
|
This function returns 1 if the log listener is enabled and 0 otherwise
If the 'value' parameter is 1, this function enables the log listener object
Thsi function retrieves the listening address for the log listener
This function sets the address for the log listener. Returns 0 on succes, -1 on failure
This function adds a log rule to the log service. The log rules can be used for example to enable separate logging for Axigen modules (i.e. the POP3 service loggs in a file with a logLevel, the SMTP-IN service loggs in other file with a bigger logLevel
This function removes a log rule
This function obtains the priority of a log level
|
| log_rule_priority_set |
int log_rule_priority_set (object:log_rule obj, int value) |
|
This function sets the priority of the log rule
|
rule_rotate_period
| Function name |
Function signature |
| log_rule_rotate_period_set |
int log_rule_rotate_period_set (object:log_rule obj, string value) |
|
This function sets the log rotate period. This will be override the log file file_time. Accepted values for the 'value' parameters are: "none", "day", "week" or "month"
|
| log_rule_rotate_period_get |
string log_rule_rotate_period_get (object:log_rule obj) |
|
This function returns the log rotate period. This period, if setted, overrides the file time for the log file. Expected returns values are: "none", "day", "week" or "month"
|
rule_file_count
| Function name |
Function signature |
| log_rule_file_count_get |
int log_rule_file_count_get (object:log_rule obj) |
|
This function returns the maximum number of old log files kept
|
| log_rule_file_count_set |
int log_rule_file_count_set (object:log_rule obj, int value) |
|
This functin sets the maximum number of old log files that will be kept
|
rule_hostname
| Function name |
Function signature |
| log_rule_hostname_get |
string log_rule_hostname_get (object:log_rule obj) |
|
This function returns the logging host for the log rule
|
| log_rule_hostname_set |
int log_rule_hostname_set (object:log_rule obj, string value) |
|
This function sets the logging host address for this log rule. It will be used if the log type is remote. Returns 0 on succes, -1 on failure
|
rule_file_name
| Function name |
Function signature |
| log_rule_file_name_get |
string log_rule_file_name_get (object:log_rule obj) |
|
This function returns the local log file used for logging if the log type is local
|
| log_rule_file_name_set |
int log_rule_file_name_set (object:log_rule obj, string value) |
|
This function sets the file path for the logging file. This file is used for logging when the log type is local
|
rule_file_size
| Function name |
Function signature |
| log_rule_file_size_get |
int log_rule_file_size_get (object:log_rule obj) |
|
This function gets the maximum file size for the log file (in KB)
|
| log_rule_file_size_set |
int log_rule_file_size_set (object:log_rule obj, int value) |
|
This function sets the maximum file size for the log file. The parameter 'value' signifies the log file size in KB
|
rule_file_time
| Function name |
Function signature |
| log_rule_file_time_set |
int log_rule_file_time_set (object:log_rule obj, int value) |
|
This function sets the maximum duration for the log file. The parameter 'value' signifies the maximum duration in seconds
|
| log_rule_file_time_get |
int log_rule_file_time_get (object:log_rule obj) |
|
This function gets the maximum duration for this log file (in seconds)
|
log_host
| Function name |
Function signature |
| log_log_host_get |
string log_log_host_get (object:log obj) |
|
This function returns the host which handles the logging (if the log type is not local)
|
| log_log_host_set |
int log_log_host_set (object:log obj, string value) |
|
This function returns the host which handles the logging (if the log type is not local)
|
rule_module
| Function name |
Function signature |
| log_rule_module_get |
string log_rule_module_get (object:log_rule obj) |
|
This function returns returns the module that does the logging. Return values can be "*" meaning any module or "pop3" meaning the pop3 module.
|
| log_rule_module_set |
int log_rule_module_set (object:log_rule obj, string value) |
|
This function sets the Axigen modules that will log through this log rule. The 'value' parameter can be "*" meaning every module or "pop3" for the pop3 module or "pop3 imap" for the pop3 & imap modules. Returns 0 on succes, -1 on failure
|
log_level
| Function name |
Function signature |
| log_log_level_get |
int log_log_level_get (object:log obj) |
|
This function returns the log level for this service. For more information of service log level, read the Axigen documentation
|
| log_log_level_set |
int log_log_level_set (object:log obj, int val) |
|
This function sets the log type for this service. Valid values for the 'value' parameter are: "internal"(used at logging in a local file), "system"(used at logging in system log) or "remote"(used at logging on a dedicated logging machine)
|
path
| Function name |
Function signature |
| log_path_get |
string log_path_get (object:log log) |
|
This function returns the path to the log directory
|
rule_log_level
| Function name |
Function signature |
| log_rule_log_level_get |
int log_rule_log_level_get (object:log_rule obj) |
|
This function returns the logging level
|
| log_rule_log_level_set |
int log_rule_log_level_set (object:log_rule obj, int value) |
|
This function sets the log level for this rule
|
log_type
| Function name |
Function signature |
| log_log_type_get |
string log_log_type_get (object:log obj) |
|
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
|
| log_log_type_set |
int log_log_type_set (object:log obj, string value) |
|
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
|
2. Methods
| Function name |
Function signature |
| log_listeners_load |
int log_listeners_load (object:log log, object:session session) |
| log_destroy |
int log_destroy (object:log log) |
|
This function destroys a cli object
|
| log_reset |
int log_reset (object:log log, object:session session) |
|
This function resets the changes made but not yet saved
|
| log_listener_remove |
int log_listener_remove (object:log_listener listener, object:log log, object:session s) |
|
This function removes a log listener
|
| log_load |
object:log log_load (object:session session, object:context_list context) |
| log_save |
int log_save (object:log serv, object:session session) |
|
This function saves the cli configuration back to Axigen
|
| log_listener_add |
object:log_listener log_listener_add (object:log log, object:session session, string address) |
|
This function returns creates a log listener
|
3. Member Objects
listeners
Functions that apply to member object:
| Function name |
Function signature |
| imap_listeners_get |
object:listeners imap_listeners_get (object:imap imap, object:session s) |
|
This function returns the listener list of this service
|
4. Iterators
listener
| Function name |
Function signature |
| log_listener_iterator_begin |
object:log_listener_iterator log_listener_iterator_begin (object:log log) |
|
This function returns a log listener iterator object. It should be used to iterate through the log listeners
|
| log_listener_iterator_has_value |
int log_listener_iterator_has_value (object:log_listener_iterator iter) |
|
This function returns 1 if the iterator has NOT reached the end of the list and 0 otherwise
|
| log_listener_iterator_value |
object:log_listener log_listener_iterator_value (object:log_listener_iterator iter) |
|
This function saves the configuration of a log listener back to Axigen.
This function returns a log listener object corresponding the iterator's position in the log listeners list
|
| log_listener_iterator_destroy |
int log_listener_iterator_destroy (object:log_listener_iterator iter) |
|
This function distroys a log_listener iterator object
|
| log_listener_iterator_next |
int log_listener_iterator_next (object:log_listener_iterator iter) |
|
This function increments the log listener iterator
|
rule
| Function name |
Function signature |
| log_rule_iterator_begin |
object:log_rule_iterator log_rule_iterator_begin (object:log log) |
|
This function returns a iterator to be used at iterating through a log rule list
|
| log_rule_iterator_next |
int log_rule_iterator_next (object:log_rule_iterator iter) |
|
This function increments the log rule iterator iterator
|
| log_rule_iterator_has_value |
int log_rule_iterator_has_value (object:log_rule_iterator iter) |
|
This function returns 1 if the log rule iterator has NOT reached the end of the list and 0 otherwise
|
| log_rule_iterator_value |
object:log_rule log_rule_iterator_value (object:log_rule_iterator iter) |
|
This function returns a log rule object corresonding the iterator's position in the log rule list
|
| log_rule_iterator_destroy |
int log_rule_iterator_destroy (object:log_rule_iterator iter) |
|
This function destroyes a log rule iterator object
|
5. Iterated objects Object: log_listener
Methods
| Function name |
Function signature |
| log_listeners_load |
int log_listeners_load (object:log log, object:session session) |
| log_listener_remove |
int log_listener_remove (object:log_listener listener, object:log log, object:session s) |
|
This function removes a log listener
|
| log_listener_add |
object:log_listener log_listener_add (object:log log, object:session session, string address) |
|
This function returns creates a log listener
|
Object: log_rule
Fields
file_count
| Function name |
Function signature |
| log_rule_file_count_get |
int log_rule_file_count_get (object:log_rule obj) |
|
This function returns the maximum number of old log files kept
|
| log_rule_file_count_set |
int log_rule_file_count_set (object:log_rule obj, int value) |
|
This functin sets the maximum number of old log files that will be kept
|
module
| Function name |
Function signature |
| log_rule_module_get |
string log_rule_module_get (object:log_rule obj) |
|
This function returns returns the module that does the logging. Return values can be "*" meaning any module or "pop3" meaning the pop3 module.
|
| log_rule_module_set |
int log_rule_module_set (object:log_rule obj, string value) |
|
This function sets the Axigen modules that will log through this log rule. The 'value' parameter can be "*" meaning every module or "pop3" for the pop3 module or "pop3 imap" for the pop3 & imap modules. Returns 0 on succes, -1 on failure
|
file_name
| Function name |
Function signature |
| log_rule_file_name_get |
string log_rule_file_name_get (object:log_rule obj) |
|
This function returns the local log file used for logging if the log type is local
|
| log_rule_file_name_set |
int log_rule_file_name_set (object:log_rule obj, string value) |
|
This function sets the file path for the logging file. This file is used for logging when the log type is local
|
priority
| Function name |
Function signature |
| log_rule_priority_get |
int log_rule_priority_get (object:log_rule obj) |
|
This function returns 1 if the log listener is enabled and 0 otherwise
If the 'value' parameter is 1, this function enables the log listener object
Thsi function retrieves the listening address for the log listener
This function sets the address for the log listener. Returns 0 on succes, -1 on failure
This function adds a log rule to the log service. The log rules can be used for example to enable separate logging for Axigen modules (i.e. the POP3 service loggs in a file with a logLevel, the SMTP-IN service loggs in other file with a bigger logLevel
This function removes a log rule
This function obtains the priority of a log level
|
| log_rule_priority_set |
int log_rule_priority_set (object:log_rule obj, int value) |
|
This function sets the priority of the log rule
|
file_size
| Function name |
Function signature |
| log_rule_file_size_get |
int log_rule_file_size_get (object:log_rule obj) |
|
This function gets the maximum file size for the log file (in KB)
|
| log_rule_file_size_set |
int log_rule_file_size_set (object:log_rule obj, int value) |
|
This function sets the maximum file size for the log file. The parameter 'value' signifies the log file size in KB
|
rotate_period
| Function name |
Function signature |
| log_rule_rotate_period_set |
int log_rule_rotate_period_set (object:log_rule obj, string value) |
|
This function sets the log rotate period. This will be override the log file file_time. Accepted values for the 'value' parameters are: "none", "day", "week" or "month"
|
| log_rule_rotate_period_get |
string log_rule_rotate_period_get (object:log_rule obj) |
|
This function returns the log rotate period. This period, if setted, overrides the file time for the log file. Expected returns values are: "none", "day", "week" or "month"
|
hostname
| Function name |
Function signature |
| log_rule_hostname_get |
string log_rule_hostname_get (object:log_rule obj) |
|
This function returns the logging host for the log rule
|
| log_rule_hostname_set |
int log_rule_hostname_set (object:log_rule obj, string value) |
|
This function sets the logging host address for this log rule. It will be used if the log type is remote. Returns 0 on succes, -1 on failure
|
log_level
| Function name |
Function signature |
| log_rule_log_level_get |
int log_rule_log_level_get (object:log_rule obj) |
|
This function returns the logging level
|
| log_rule_log_level_set |
int log_rule_log_level_set (object:log_rule obj, int value) |
|
This function sets the log level for this rule
|
file_time
| Function name |
Function signature |
| log_rule_file_time_set |
int log_rule_file_time_set (object:log_rule obj, int value) |
|
This function sets the maximum duration for the log file. The parameter 'value' signifies the maximum duration in seconds
|
| log_rule_file_time_get |
int log_rule_file_time_get (object:log_rule obj) |
|
This function gets the maximum duration for this log file (in seconds)
|
|
