protocol

# `loggingp`

Logging events to files protocol.

Author: Paulo Moura
Version: 1:0:0
Date: 2011-01-06
Compilation flags:
`static`
Dependencies:
(none)
Remarks:
(none)
Inherited public predicates:
(none)

- Public predicates

  - `log_file/2`

  - `define_log_file/2`

  - `init_log_file/2`

  - `log_event/2`

  - `logging/1`

  - `enable_logging/1`

  - `disable_logging/1`

- Protected predicates

- Private predicates

- Operators

## Public predicates

### `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`

### `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`

### `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`

### `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`

### `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`

### `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`

### `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)

See also

logging