`loggingp`

Logging events to files protocol.

| Availability: | logtalk_load(logging(loader))

| Author: Paulo Moura | Version: 1:0:0 | Date: 2011-01-06

| Compilation flags: | static

| Dependencies: | (none)

| Remarks: | (none)

| Inherited public predicates: | (none)

.. contents:: :local: :backlinks: top

Public predicates

.. index:: log_file/2 .. _loggingp/0::log_file/2:

log_file/2 ^^^^^^^^^^^^^^

Access to the table of log files.

| Compilation flags: | static

| Template: | log_file(Alias,File) | Mode and number of proofs: | log_file(?atom,?atom) - zero_or_more

.. index:: define_log_file/2 .. _loggingp/0::define_log_file/2:

define_log_file/2 ^^^^^^^^^^^^^^^^^^^^^

Defines a log file with alias Alias and file name File. If the log file already exists, its contents are kept. Logging is enabled by default.

| Compilation flags: | static

| Template: | define_log_file(Alias,File) | Mode and number of proofs: | define_log_file(+atom,+atom) - one

.. index:: init_log_file/2 .. _loggingp/0::init_log_file/2:

init_log_file/2 ^^^^^^^^^^^^^^^^^^^

Initializes a new log file with alias Alias and file name File. If the log file already exists, its contents are erased. Logging is enabled by default.

| Compilation flags: | static

| Template: | init_log_file(Alias,File) | Mode and number of proofs: | init_log_file(+atom,+atom) - one

.. index:: log_event/2 .. _loggingp/0::log_event/2:

log_event/2 ^^^^^^^^^^^^^^^

Logs an event Event to a log file with alias Alias. Fails if a log file with alias Alias is not defined.

| Compilation flags: | static

| Template: | log_event(Alias,Event) | Mode and number of proofs: | log_event(+atom,+nonvar) - zero_or_one

.. index:: logging/1 .. _loggingp/0::logging/1:

logging/1 ^^^^^^^^^^^^^

True if logging to file with alias Alias is enabled.

| Compilation flags: | static

| Template: | logging(Alias) | Mode and number of proofs: | logging(+atom) - zero_or_one

.. index:: enable_logging/1 .. _loggingp/0::enable_logging/1:

enable_logging/1 ^^^^^^^^^^^^^^^^^^^^

Enables logging to file with alias Alias. Fails if a log file with alias Alias is not defined.

| Compilation flags: | static

| Template: | enable_logging(Alias) | Mode and number of proofs: | enable_logging(+atom) - zero_or_one

.. index:: disable_logging/1 .. _loggingp/0::disable_logging/1:

disable_logging/1 ^^^^^^^^^^^^^^^^^^^^^

Disables logging to file with alias Alias. Fails if a log file with alias Alias is not defined.

| Compilation flags: | static

| Template: | disable_logging(Alias) | Mode and number of proofs: | disable_logging(+atom) - zero_or_one

Protected predicates

(none)

Private predicates

(none)

Operators

(none)

.. seealso::

:ref:`logging <logging/0>`