The irc-logger Reference Manual

This is the irc-logger Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:53:37 2022 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

irc-logger

1.1 `irc-logger`

Dependencies

cl-irc (system).
cl-ppcre (system).

Source

irc-logger.asd.

Child Components

package.lisp (file).
logger.lisp (file).

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

2.1.1 `irc-logger/irc-logger.asd`

Source: irc-logger.asd.
Parent Component: irc-logger (system).
ASDF Systems: irc-logger.
Packages: irc-logger-system.

2.1.2 `irc-logger/package.lisp`

Source: irc-logger.asd.
Parent Component: irc-logger (system).
Packages: irc-logger.

2.1.3 `irc-logger/logger.lisp`

Dependency

package.lisp (file).

Source

irc-logger.asd.

Parent Component

irc-logger (system).

Public Interface

*loggers* (special variable).
add-channel-logger (function).
add-hook-logger (function).
add-logger (function).
(setf channels) (writer method).
channels (reader method).
(setf connection) (writer method).
connection (reader method).
log-file-path (generic function).
password (reader method).
print-object (method).
remove-channel-logger (function).
remove-hook-logger (function).
remove-logger (function).

Internals

%is-connected (function).
%log-file-path (function).
%output-event (generic function).
*daemon-monitor-process* (special variable).
*msg* (special variable).
*timeout* (special variable).
*user-address-scanner* (special variable).
*warning-message-utime* (special variable).
+posix-epoch+ (constant).
action-hook (function).
add-log-entry (function).
add-private-log-entry (function).
async (reader method).
attempt-reconnection (function).
c-name (reader method).
canonicalize-channel-name (function).
channel-names (reader method).
(setf channel-names) (writer method).
create-logger (function).
current-output-names (reader method).
(setf current-output-names) (writer method).
daemon-monitor (function).
daemon-sleep (function).
do-connect-and-join (function).
ensure-output-stream (function).
ensure-output-stream-for-unichannel (function).
error-hook (function).
find-channel-with-name (function).
find-logger-with-connection (function).
find-logger-with-nick (function).
format-date-time (function).
format-utime (function).
formats (reader method).
get-format (function).
get-output-name (function).
(setf get-output-name) (function).
get-private-log-stream (function).
get-stream (function).
(setf get-stream) (function).
get-unknown-log-stream (function).
handler (reader method).
(setf handler) (writer method).
invite-hook (function).
is-connected (function).
is-unichannel-output (function).
join-hook (function).
kick-hook (function).
kill-hook (function).
l-nickname (reader method).
l-realname (reader method).
l-username (reader method).
last-pong (reader method).
(setf last-pong) (writer method).
last-sexp-field (function).
log-channel (class).
log-daemon-message (function).
log-disconnection (function).
log-file-path-utime (function).
log-reconnection (function).
logger (class).
logging-stream (reader method).
make-a-channel (function).
make-channels (function).
make-output-name (function).
make-output-name-utime (function).
mode-hook (function).
monitor-events (reader method).
(setf monitor-events) (writer method).
monitor-once (function).
need-user-address? (function).
nick-hook (function).
notice-hook (function).
output-event (function).
output-event-for-a-stream (function).
output-root (reader method).
part-hook (function).
ping-hook (function).
pong-hook (function).
port (reader method).
posix-time-to-utime (function).
private-log (reader method).
private-log-stream (reader method).
privmsg-hook (function).
quit-hook (function).
quit-with-timeout (function).
rpl_endofnames-hook (function).
rpl_namreply-hook (function).
rpl_topic-hook (function).
rpl_topicwhotime-hook (function).
server (reader method).
start-logger (function).
streams (reader method).
topic-hook (function).
unichannel (reader method).
unknown-log (reader method).
unknown-log-stream (reader method).
user-address (function).
user-output (reader method).
warning-hook (function).
warning-message-utime (reader method).
(setf warning-message-utime) (writer method).
with-decoding (macro).
write-file-footer (generic function).
write-file-header (generic function).

3 Packages

Packages are listed by definition order.

irc-logger-system
irc-logger

3.1 `irc-logger-system`

Source

irc-logger.asd.

Use List

asdf/interface.
common-lisp.

3.2 `irc-logger`

Source

package.lisp.

Use List

cl-irc.
cl-ppcre.
common-lisp.

Public Interface

*loggers* (special variable).
add-channel-logger (function).
add-hook-logger (function).
add-logger (function).
log-file-path (generic function).
remove-channel-logger (function).
remove-hook-logger (function).
remove-logger (function).

Internals

%is-connected (function).
%log-file-path (function).
%output-event (generic function).
*daemon-monitor-process* (special variable).
*msg* (special variable).
*timeout* (special variable).
*user-address-scanner* (special variable).
*warning-message-utime* (special variable).
+posix-epoch+ (constant).
action-hook (function).
add-log-entry (function).
add-private-log-entry (function).
async (generic reader).
attempt-reconnection (function).
c-name (generic reader).
canonicalize-channel-name (function).
channel-names (generic reader).
(setf channel-names) (generic writer).
create-logger (function).
current-output-names (generic reader).
(setf current-output-names) (generic writer).
daemon-monitor (function).
daemon-sleep (function).
do-connect-and-join (function).
ensure-output-stream (function).
ensure-output-stream-for-unichannel (function).
error-hook (function).
find-channel-with-name (function).
find-logger-with-connection (function).
find-logger-with-nick (function).
format-date-time (function).
format-utime (function).
formats (generic reader).
get-format (function).
get-output-name (function).
(setf get-output-name) (function).
get-private-log-stream (function).
get-stream (function).
(setf get-stream) (function).
get-unknown-log-stream (function).
handler (generic reader).
(setf handler) (generic writer).
invite-hook (function).
is-connected (function).
is-unichannel-output (function).
join-hook (function).
kick-hook (function).
kill-hook (function).
l-nickname (generic reader).
l-realname (generic reader).
l-username (generic reader).
last-pong (generic reader).
(setf last-pong) (generic writer).
last-sexp-field (function).
log-channel (class).
log-daemon-message (function).
log-disconnection (function).
log-file-path-utime (function).
log-reconnection (function).
logger (class).
logging-stream (generic reader).
make-a-channel (function).
make-channels (function).
make-output-name (function).
make-output-name-utime (function).
mode-hook (function).
monitor-events (generic reader).
(setf monitor-events) (generic writer).
monitor-once (function).
need-user-address? (function).
nick-hook (function).
notice-hook (function).
output-event (function).
output-event-for-a-stream (function).
output-root (generic reader).
part-hook (function).
ping-hook (function).
pong-hook (function).
port (generic reader).
posix-time-to-utime (function).
private-log (generic reader).
private-log-stream (generic reader).
privmsg-hook (function).
quit-hook (function).
quit-with-timeout (function).
rpl_endofnames-hook (function).
rpl_namreply-hook (function).
rpl_topic-hook (function).
rpl_topicwhotime-hook (function).
server (generic reader).
start-logger (function).
streams (generic reader).
topic-hook (function).
unichannel (generic reader).
unknown-log (generic reader).
unknown-log-stream (generic reader).
user-address (function).
user-output (generic reader).
warning-hook (function).
warning-message-utime (generic reader).
(setf warning-message-utime) (generic writer).
with-decoding (macro).
write-file-footer (generic function).
write-file-header (generic function).

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

4.1 Public Interface

Special variables
Ordinary functions
Generic functions
Standalone methods

4.1.1 Special variables

Special Variable: *loggers* ¶

List of active loggers.

Package: irc-logger.
Source: logger.lisp.

4.1.2 Ordinary functions

Function: add-channel-logger (logger channel-name) ¶

Package: irc-logger.
Source: logger.lisp.

Function: add-hook-logger (logger class hook) ¶

Package: irc-logger.
Source: logger.lisp.

Function: add-logger (nick server &key port channels output password realname username private-log unknown-log logging-stream async formats) ¶

Package: irc-logger.
Source: logger.lisp.

Function: remove-channel-logger (logger channel-name) ¶

Package: irc-logger.
Source: logger.lisp.

Function: remove-hook-logger (logger class hook) ¶

Package: irc-logger.
Source: logger.lisp.

Function: remove-logger (nick) ¶

Quit the active connection with nick and remove from active list.

Package: irc-logger.
Source: logger.lisp.

4.1.3 Generic functions

Generic Function: log-file-path (output-root channel-name year month day format) ¶

Package

irc-logger.

Source

logger.lisp.

Methods

Method: log-file-path (output-root channel-name year month day (format string)) ¶

Method: log-file-path (output-root channel-name year month day (format (eql :text))) ¶

Method: log-file-path (output-root channel-name year month day (format (eql :binary))) ¶

Method: log-file-path (output-root channel-name year month day (format (eql :sexp))) ¶

Method: log-file-path (output-root channel-name year month day (format (eql :raw))) ¶

4.1.4 Standalone methods

Writer Method: (setf channels) ((logger logger)) ¶

List of channels.

Package: cl-irc.
Source: logger.lisp.
Target Slot: channels.

Reader Method: channels ((logger logger)) ¶

List of channels.

Package: cl-irc.
Source: logger.lisp.
Target Slot: channels.

Writer Method: (setf connection) ((logger logger)) ¶

IRC connection object.

Package: cl-irc.
Source: logger.lisp.
Target Slot: connection.

Reader Method: connection ((logger logger)) ¶

IRC connection object.

Package: cl-irc.
Source: logger.lisp.
Target Slot: connection.

Reader Method: password ((logger logger)) ¶

Nickname’s nickserver password.

Package: cl-irc.
Source: logger.lisp.
Target Slot: password.

Method: print-object ((obj logger) stream) ¶

Source: logger.lisp.

4.2 Internals

Constants
Special variables
Macros
Ordinary functions
Generic functions
Classes

4.2.1 Constants

Constant: +posix-epoch+ ¶

Package: irc-logger.
Source: logger.lisp.

4.2.2 Special variables

Special Variable: *daemon-monitor-process* ¶

Process of background monitor.

Package: irc-logger.
Source: logger.lisp.

Special Variable: *msg* ¶

Package: irc-logger.
Source: logger.lisp.

Special Variable: *timeout* ¶

Package: irc-logger.
Source: logger.lisp.

Special Variable: *user-address-scanner* ¶

Package: irc-logger.
Source: logger.lisp.

Special Variable: *warning-message-utime* ¶

Package: irc-logger.
Source: logger.lisp.

4.2.3 Macros

Macro: with-decoding ((utime &optional zone) &body body) ¶

Package: irc-logger.
Source: logger.lisp.

4.2.4 Ordinary functions

Function: %is-connected (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: %log-file-path (output-root channel-name year month day type) ¶

Package: irc-logger.
Source: logger.lisp.

Function: action-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: add-log-entry (stream fmt &rest args) ¶

Package: irc-logger.
Source: logger.lisp.

Function: add-private-log-entry (logger fmt &rest args) ¶

Package: irc-logger.
Source: logger.lisp.

Function: attempt-reconnection (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: canonicalize-channel-name (name) ¶

Package: irc-logger.
Source: logger.lisp.

Function: create-logger (nick server &key port channels output password realname username async private-log unknown-log logging-stream formats) ¶

OUTPUT may be a pathname or a stream

Package: irc-logger.
Source: logger.lisp.

Function: daemon-monitor () ¶

This function runs in the background and monitors the connection of the logger.

Package: irc-logger.
Source: logger.lisp.

Function: daemon-sleep (seconds) ¶

Package: irc-logger.
Source: logger.lisp.

Function: do-connect-and-join (nick server port username realname logging-stream channels) ¶

Package: irc-logger.
Source: logger.lisp.

Function: ensure-output-stream (utime logger channel istream) ¶

Ensures that *output-stream* is correct.

Package: irc-logger.
Source: logger.lisp.

Function: ensure-output-stream-for-unichannel (utime logger channel istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: error-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: find-channel-with-name (logger name) ¶

Package: irc-logger.
Source: logger.lisp.

Function: find-logger-with-connection (conn) ¶

Package: irc-logger.
Source: logger.lisp.

Function: find-logger-with-nick (nick) ¶

Package: irc-logger.
Source: logger.lisp.

Function: format-date-time (utime &key stream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: format-utime (utime &optional zone) ¶

Package: irc-logger.
Source: logger.lisp.

Function: get-format (logger istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: get-output-name (channel istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: (setf get-output-name) (channel istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: get-private-log-stream (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: get-stream (channel istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: (setf get-stream) (channel istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: get-unknown-log-stream (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: invite-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: is-connected (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: is-unichannel-output (user-output) ¶

Returns T if output is setup for a single channel directory structure.

Package: irc-logger.
Source: logger.lisp.

Function: join-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: kick-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: kill-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: last-sexp-field (type msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: log-daemon-message (logger fmt &rest args) ¶

Package: irc-logger.
Source: logger.lisp.

Function: log-disconnection (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: log-file-path-utime (output-root channel-name format utime) ¶

Package: irc-logger.
Source: logger.lisp.

Function: log-reconnection (logger) ¶

Package: irc-logger.
Source: logger.lisp.

Function: make-a-channel (name formats output) ¶

Package: irc-logger.
Source: logger.lisp.

Function: make-channels (names formats output) ¶

Package: irc-logger.
Source: logger.lisp.

Function: make-output-name (name year month day) ¶

Package: irc-logger.
Source: logger.lisp.

Function: make-output-name-utime (name utime) ¶

Package: irc-logger.
Source: logger.lisp.

Function: mode-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: monitor-once () ¶

Package: irc-logger.
Source: logger.lisp.

Function: need-user-address? (type) ¶

Package: irc-logger.
Source: logger.lisp.

Function: nick-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: notice-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: output-event (msg type channel-name &optional text) ¶

Package: irc-logger.
Source: logger.lisp.

Function: output-event-for-a-stream (msg type channel text logger istream) ¶

Package: irc-logger.
Source: logger.lisp.

Function: part-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: ping-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: pong-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: posix-time-to-utime (time) ¶

Package: irc-logger.
Source: logger.lisp.

Function: privmsg-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: quit-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: quit-with-timeout (connection msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: rpl_endofnames-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: rpl_namreply-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: rpl_topic-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: rpl_topicwhotime-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: start-logger (logger async) ¶

Package: irc-logger.
Source: logger.lisp.

Function: topic-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: user-address (msg) ¶

Package: irc-logger.
Source: logger.lisp.

Function: warning-hook (msg) ¶

Package: irc-logger.
Source: logger.lisp.

4.2.5 Generic functions

Generic Function: %output-event (format stream utime type channel source text msg unichannel) ¶

Package

irc-logger.

Source

logger.lisp.

Methods

Method: %output-event ((format (eql :text)) stream utime type channel source text msg unichannel) ¶

Method: %output-event ((format (eql :sexp)) stream utime type channel source text msg unichannel) ¶

Method: %output-event ((format (eql :raw)) stream utime type channel source text msg unichannel) ¶

Method: %output-event (format stream utime type channel source text msg unichannel) ¶

Generic Reader: async (object) ¶

Package

irc-logger.

Methods

Reader Method: async ((logger logger)) ¶

Whether to use async

Source: logger.lisp.
Target Slot: async.

Generic Reader: c-name (object) ¶

Package

irc-logger.

Methods

Reader Method: c-name ((log-channel log-channel)) ¶

Name of channel.

Source: logger.lisp.
Target Slot: name.

Generic Reader: channel-names (object) ¶

Generic Writer: (setf channel-names) (object) ¶

Package

irc-logger.

Methods

Reader Method: channel-names ((logger logger)) ¶

Writer Method: (setf channel-names) ((logger logger)) ¶

List of channel names.

Source: logger.lisp.
Target Slot: channel-names.

Generic Reader: current-output-names (object) ¶

Package

irc-logger.

Methods

Reader Method: current-output-names ((log-channel log-channel)) ¶

automatically generated reader method

Source: logger.lisp.
Target Slot: current-output-names.

Generic Writer: (setf current-output-names) (object) ¶

Package

irc-logger.

Methods

Writer Method: (setf current-output-names) ((log-channel log-channel)) ¶

automatically generated writer method

Source: logger.lisp.
Target Slot: current-output-names.

Generic Reader: formats (object) ¶

Package

irc-logger.

Methods

Reader Method: formats ((logger logger)) ¶

A list of output formats.

Source: logger.lisp.
Target Slot: formats.

Generic Reader: handler (object) ¶

Generic Writer: (setf handler) (object) ¶

Package

irc-logger.

Methods

Reader Method: handler ((logger logger)) ¶

Writer Method: (setf handler) ((logger logger)) ¶

Background handler process.

Source: logger.lisp.
Target Slot: handler.

Generic Reader: l-nickname (object) ¶

Package

irc-logger.

Methods

Reader Method: l-nickname ((logger logger)) ¶

Nickname of the bot.

Source: logger.lisp.
Target Slot: nick.

Generic Reader: l-realname (object) ¶

Package

irc-logger.

Methods

Reader Method: l-realname ((logger logger)) ¶

Realname for cl-irc

Source: logger.lisp.
Target Slot: realname.

Generic Reader: l-username (object) ¶

Package

irc-logger.

Methods

Reader Method: l-username ((logger logger)) ¶

Username for cl-irc

Source: logger.lisp.
Target Slot: username.

Generic Reader: last-pong (object) ¶

Generic Writer: (setf last-pong) (object) ¶

Package

irc-logger.

Methods

Reader Method: last-pong ((logger logger)) ¶

Writer Method: (setf last-pong) ((logger logger)) ¶

utime of last pong message

Source: logger.lisp.
Target Slot: last-pong.

Generic Reader: logging-stream (object) ¶

Package

irc-logger.

Methods

Reader Method: logging-stream ((logger logger)) ¶

logging-stream for cl-irc.

Source: logger.lisp.
Target Slot: logging-stream.

Generic Reader: monitor-events (object) ¶

Generic Writer: (setf monitor-events) (object) ¶

Package

irc-logger.

Methods

Reader Method: monitor-events ((logger logger)) ¶

Writer Method: (setf monitor-events) ((logger logger)) ¶

List of events for the monitor to process.

Source: logger.lisp.
Target Slot: monitor-events.

Generic Reader: output-root (object) ¶

Package

irc-logger.

Methods

Reader Method: output-root ((log-channel log-channel)) ¶

automatically generated reader method

Source: logger.lisp.
Target Slot: output-root.

Generic Reader: port (object) ¶

Package

irc-logger.

Methods

Reader Method: port ((logger logger)) ¶

Connected IRC server’s port.

Source: logger.lisp.
Target Slot: port.

Generic Reader: private-log (object) ¶

Package

irc-logger.

Methods

Reader Method: private-log ((logger logger)) ¶

Pathname of the private log file for the daemon.

Source: logger.lisp.
Target Slot: private-log.

Generic Reader: private-log-stream (object) ¶

Package

irc-logger.

Methods

Reader Method: private-log-stream ((logger logger)) ¶

Stream of the private log file for the daemon.

Source: logger.lisp.
Target Slot: private-log-stream.

Generic Reader: server (object) ¶

Package

irc-logger.

Methods

Reader Method: server ((logger logger)) ¶

Connected IRC server.

Source: logger.lisp.
Target Slot: server.

Generic Reader: streams (object) ¶

Package

irc-logger.

Methods

Reader Method: streams ((log-channel log-channel)) ¶

List of output streams.

Source: logger.lisp.
Target Slot: streams.

Generic Reader: unichannel (object) ¶

Package

irc-logger.

Methods

Reader Method: unichannel ((logger logger)) ¶

T if user-output is directory for individual channel output.

Source: logger.lisp.
Target Slot: unichannel.

Generic Reader: unknown-log (object) ¶

Package

irc-logger.

Methods

Reader Method: unknown-log ((logger logger)) ¶

Pathname of the log file for unknown messages.

Source: logger.lisp.
Target Slot: unknown-log.

Generic Reader: unknown-log-stream (object) ¶

Package

irc-logger.

Methods

Reader Method: unknown-log-stream ((logger logger)) ¶

Stream of the log file for unknown messages.

Source: logger.lisp.
Target Slot: unknown-log-stream.

Generic Reader: user-output (object) ¶

Package

irc-logger.

Methods

Reader Method: user-output ((logger logger)) ¶

Output parameter from user, maybe stream or pathname.

Source: logger.lisp.
Target Slot: user-output.

Generic Reader: warning-message-utime (object) ¶

Generic Writer: (setf warning-message-utime) (object) ¶

Package

irc-logger.

Methods

Reader Method: warning-message-utime ((logger logger)) ¶

Writer Method: (setf warning-message-utime) ((logger logger)) ¶

Time of last, potentially active, warning message.

Source: logger.lisp.
Target Slot: warning-message-utime.

Generic Function: write-file-footer (format channel-name stream) ¶

Package

irc-logger.

Source

logger.lisp.

Methods

Method: write-file-footer (format channel-name stream) ¶

Generic Function: write-file-header (format channel-name stream) ¶

Package

irc-logger.

Source

logger.lisp.

Methods

Method: write-file-header (format channel-name stream) ¶

4.2.6 Classes

Class: log-channel ¶

Package

irc-logger.

Source

logger.lisp.

Direct methods

c-name.
(setf current-output-names).
current-output-names.
output-root.
streams.

Direct slots

Slot: name ¶

Name of channel.

Package: cl-irc.
Initargs: :name
Readers: c-name.
Writers: This slot is read-only.

Slot: streams ¶

List of output streams.

Initargs: :streams
Readers: streams.
Writers: This slot is read-only.

Slot: output-root ¶

Initargs: :output-root
Readers: output-root.
Writers: This slot is read-only.

Slot: current-output-names ¶

Initargs: :current-output-names
Readers: current-output-names.
Writers: (setf current-output-names).

Class: logger ¶

Package

irc-logger.

Source

logger.lisp.

Direct methods

async.
(setf channel-names).
channel-names.
(setf channels).
channels.
(setf connection).
connection.
formats.
(setf handler).
handler.
l-nickname.
l-realname.
l-username.
(setf last-pong).
last-pong.
logging-stream.
(setf monitor-events).
monitor-events.
password.
port.
print-object.
private-log.
private-log-stream.
server.
unichannel.
unknown-log.
unknown-log-stream.
user-output.
(setf warning-message-utime).
warning-message-utime.

Direct slots

Slot: connection ¶

IRC connection object.

Package: cl-irc.
Initargs: :connection
Readers: connection.
Writers: (setf connection).

Slot: handler ¶

Background handler process.

Readers: handler.
Writers: (setf handler).

Slot: nick ¶

Nickname of the bot.

Package: cl-irc.
Initargs: :nick
Readers: l-nickname.
Writers: This slot is read-only.

Slot: password ¶

Nickname’s nickserver password.

Package: cl-irc.
Initargs: :password
Readers: password.
Writers: This slot is read-only.

Slot: server ¶

Connected IRC server.

Initargs: :server
Readers: server.
Writers: This slot is read-only.

Slot: port ¶

Connected IRC server’s port.

Initargs: :port
Readers: port.
Writers: This slot is read-only.

Slot: channel-names ¶

List of channel names.

Initargs: :channel-names
Readers: channel-names.
Writers: (setf channel-names).

Slot: realname ¶

Realname for cl-irc

Package: cl-irc.
Initargs: :realname
Readers: l-realname.
Writers: This slot is read-only.

Slot: username ¶

Username for cl-irc

Package: cl-irc.
Initargs: :username
Readers: l-username.
Writers: This slot is read-only.

Slot: logging-stream ¶

logging-stream for cl-irc.

Initargs: :logging-stream
Readers: logging-stream.
Writers: This slot is read-only.

Slot: channels ¶

List of channels.

Package: cl-irc.
Initargs: :channels
Readers: channels.
Writers: (setf channels).

Slot: user-output ¶

Output parameter from user, maybe stream or pathname.

Initargs: :user-output
Readers: user-output.
Writers: This slot is read-only.

Slot: unichannel ¶

T if user-output is directory for individual channel output.

Type: boolean
Initargs: :unichannel
Readers: unichannel.
Writers: This slot is read-only.

Slot: formats ¶

A list of output formats.

Initargs: :formats
Readers: formats.
Writers: This slot is read-only.

Slot: async ¶

Whether to use async

Initargs: :async
Readers: async.
Writers: This slot is read-only.

Slot: last-pong ¶

utime of last pong message

Readers: last-pong.
Writers: (setf last-pong).

Slot: private-log ¶

Pathname of the private log file for the daemon.

Initargs: :private-log
Readers: private-log.
Writers: This slot is read-only.

Slot: unknown-log ¶

Pathname of the log file for unknown messages.

Initargs: :unknown-log
Readers: unknown-log.
Writers: This slot is read-only.

Slot: private-log-stream ¶

Stream of the private log file for the daemon.

Initargs: :private-log-stream
Readers: private-log-stream.
Writers: This slot is read-only.

Slot: unknown-log-stream ¶

Stream of the log file for unknown messages.

Initargs: :unknown-log-stream
Readers: unknown-log-stream.
Writers: This slot is read-only.

Slot: monitor-events ¶

List of events for the monitor to process.

Readers: monitor-events.
Writers: (setf monitor-events).

Slot: warning-message-utime ¶

Time of last, potentially active, warning message.

Readers: warning-message-utime.
Writers: (setf warning-message-utime).

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	% ( A C D E F G H I J K L M N O P Q R S T U W

	Index Entry	Section

%
	`%is-connected`:	Private ordinary functions
	`%log-file-path`:	Private ordinary functions
	`%output-event`:	Private generic functions
	`%output-event`:	Private generic functions
	`%output-event`:	Private generic functions
	`%output-event`:	Private generic functions
	`%output-event`:	Private generic functions

(
	`(setf channel-names)`:	Private generic functions
	`(setf channel-names)`:	Private generic functions
	`(setf channels)`:	Public standalone methods
	`(setf connection)`:	Public standalone methods
	`(setf current-output-names)`:	Private generic functions
	`(setf current-output-names)`:	Private generic functions
	`(setf get-output-name)`:	Private ordinary functions
	`(setf get-stream)`:	Private ordinary functions
	`(setf handler)`:	Private generic functions
	`(setf handler)`:	Private generic functions
	`(setf last-pong)`:	Private generic functions
	`(setf last-pong)`:	Private generic functions
	`(setf monitor-events)`:	Private generic functions
	`(setf monitor-events)`:	Private generic functions
	`(setf warning-message-utime)`:	Private generic functions
	`(setf warning-message-utime)`:	Private generic functions

A
	`action-hook`:	Private ordinary functions
	`add-channel-logger`:	Public ordinary functions
	`add-hook-logger`:	Public ordinary functions
	`add-log-entry`:	Private ordinary functions
	`add-logger`:	Public ordinary functions
	`add-private-log-entry`:	Private ordinary functions
	`async`:	Private generic functions
	`async`:	Private generic functions
	`attempt-reconnection`:	Private ordinary functions

C
	`c-name`:	Private generic functions
	`c-name`:	Private generic functions
	`canonicalize-channel-name`:	Private ordinary functions
	`channel-names`:	Private generic functions
	`channel-names`:	Private generic functions
	`channels`:	Public standalone methods
	`connection`:	Public standalone methods
	`create-logger`:	Private ordinary functions
	`current-output-names`:	Private generic functions
	`current-output-names`:	Private generic functions

D
	`daemon-monitor`:	Private ordinary functions
	`daemon-sleep`:	Private ordinary functions
	`do-connect-and-join`:	Private ordinary functions

E
	`ensure-output-stream`:	Private ordinary functions
	`ensure-output-stream-for-unichannel`:	Private ordinary functions
	`error-hook`:	Private ordinary functions

F
	`find-channel-with-name`:	Private ordinary functions
	`find-logger-with-connection`:	Private ordinary functions
	`find-logger-with-nick`:	Private ordinary functions
	`format-date-time`:	Private ordinary functions
	`format-utime`:	Private ordinary functions
	`formats`:	Private generic functions
	`formats`:	Private generic functions
	`Function, %is-connected`:	Private ordinary functions
	`Function, %log-file-path`:	Private ordinary functions
	`Function, (setf get-output-name)`:	Private ordinary functions
	`Function, (setf get-stream)`:	Private ordinary functions
	`Function, action-hook`:	Private ordinary functions
	`Function, add-channel-logger`:	Public ordinary functions
	`Function, add-hook-logger`:	Public ordinary functions
	`Function, add-log-entry`:	Private ordinary functions
	`Function, add-logger`:	Public ordinary functions
	`Function, add-private-log-entry`:	Private ordinary functions
	`Function, attempt-reconnection`:	Private ordinary functions
	`Function, canonicalize-channel-name`:	Private ordinary functions
	`Function, create-logger`:	Private ordinary functions
	`Function, daemon-monitor`:	Private ordinary functions
	`Function, daemon-sleep`:	Private ordinary functions
	`Function, do-connect-and-join`:	Private ordinary functions
	`Function, ensure-output-stream`:	Private ordinary functions
	`Function, ensure-output-stream-for-unichannel`:	Private ordinary functions
	`Function, error-hook`:	Private ordinary functions
	`Function, find-channel-with-name`:	Private ordinary functions
	`Function, find-logger-with-connection`:	Private ordinary functions
	`Function, find-logger-with-nick`:	Private ordinary functions
	`Function, format-date-time`:	Private ordinary functions
	`Function, format-utime`:	Private ordinary functions
	`Function, get-format`:	Private ordinary functions
	`Function, get-output-name`:	Private ordinary functions
	`Function, get-private-log-stream`:	Private ordinary functions
	`Function, get-stream`:	Private ordinary functions
	`Function, get-unknown-log-stream`:	Private ordinary functions
	`Function, invite-hook`:	Private ordinary functions
	`Function, is-connected`:	Private ordinary functions
	`Function, is-unichannel-output`:	Private ordinary functions
	`Function, join-hook`:	Private ordinary functions
	`Function, kick-hook`:	Private ordinary functions
	`Function, kill-hook`:	Private ordinary functions
	`Function, last-sexp-field`:	Private ordinary functions
	`Function, log-daemon-message`:	Private ordinary functions
	`Function, log-disconnection`:	Private ordinary functions
	`Function, log-file-path-utime`:	Private ordinary functions
	`Function, log-reconnection`:	Private ordinary functions
	`Function, make-a-channel`:	Private ordinary functions
	`Function, make-channels`:	Private ordinary functions
	`Function, make-output-name`:	Private ordinary functions
	`Function, make-output-name-utime`:	Private ordinary functions
	`Function, mode-hook`:	Private ordinary functions
	`Function, monitor-once`:	Private ordinary functions
	`Function, need-user-address?`:	Private ordinary functions
	`Function, nick-hook`:	Private ordinary functions
	`Function, notice-hook`:	Private ordinary functions
	`Function, output-event`:	Private ordinary functions
	`Function, output-event-for-a-stream`:	Private ordinary functions
	`Function, part-hook`:	Private ordinary functions
	`Function, ping-hook`:	Private ordinary functions
	`Function, pong-hook`:	Private ordinary functions
	`Function, posix-time-to-utime`:	Private ordinary functions
	`Function, privmsg-hook`:	Private ordinary functions
	`Function, quit-hook`:	Private ordinary functions
	`Function, quit-with-timeout`:	Private ordinary functions
	`Function, remove-channel-logger`:	Public ordinary functions
	`Function, remove-hook-logger`:	Public ordinary functions
	`Function, remove-logger`:	Public ordinary functions
	`Function, rpl_endofnames-hook`:	Private ordinary functions
	`Function, rpl_namreply-hook`:	Private ordinary functions
	`Function, rpl_topic-hook`:	Private ordinary functions
	`Function, rpl_topicwhotime-hook`:	Private ordinary functions
	`Function, start-logger`:	Private ordinary functions
	`Function, topic-hook`:	Private ordinary functions
	`Function, user-address`:	Private ordinary functions
	`Function, warning-hook`:	Private ordinary functions

G
	`Generic Function, %output-event`:	Private generic functions
	`Generic Function, (setf channel-names)`:	Private generic functions
	`Generic Function, (setf current-output-names)`:	Private generic functions
	`Generic Function, (setf handler)`:	Private generic functions
	`Generic Function, (setf last-pong)`:	Private generic functions
	`Generic Function, (setf monitor-events)`:	Private generic functions
	`Generic Function, (setf warning-message-utime)`:	Private generic functions
	`Generic Function, async`:	Private generic functions
	`Generic Function, c-name`:	Private generic functions
	`Generic Function, channel-names`:	Private generic functions
	`Generic Function, current-output-names`:	Private generic functions
	`Generic Function, formats`:	Private generic functions
	`Generic Function, handler`:	Private generic functions
	`Generic Function, l-nickname`:	Private generic functions
	`Generic Function, l-realname`:	Private generic functions
	`Generic Function, l-username`:	Private generic functions
	`Generic Function, last-pong`:	Private generic functions
	`Generic Function, log-file-path`:	Public generic functions
	`Generic Function, logging-stream`:	Private generic functions
	`Generic Function, monitor-events`:	Private generic functions
	`Generic Function, output-root`:	Private generic functions
	`Generic Function, port`:	Private generic functions
	`Generic Function, private-log`:	Private generic functions
	`Generic Function, private-log-stream`:	Private generic functions
	`Generic Function, server`:	Private generic functions
	`Generic Function, streams`:	Private generic functions
	`Generic Function, unichannel`:	Private generic functions
	`Generic Function, unknown-log`:	Private generic functions
	`Generic Function, unknown-log-stream`:	Private generic functions
	`Generic Function, user-output`:	Private generic functions
	`Generic Function, warning-message-utime`:	Private generic functions
	`Generic Function, write-file-footer`:	Private generic functions
	`Generic Function, write-file-header`:	Private generic functions
	`get-format`:	Private ordinary functions
	`get-output-name`:	Private ordinary functions
	`get-private-log-stream`:	Private ordinary functions
	`get-stream`:	Private ordinary functions
	`get-unknown-log-stream`:	Private ordinary functions

H
	`handler`:	Private generic functions
	`handler`:	Private generic functions

I
	`invite-hook`:	Private ordinary functions
	`is-connected`:	Private ordinary functions
	`is-unichannel-output`:	Private ordinary functions

J
	`join-hook`:	Private ordinary functions

K
	`kick-hook`:	Private ordinary functions
	`kill-hook`:	Private ordinary functions

L
	`l-nickname`:	Private generic functions
	`l-nickname`:	Private generic functions
	`l-realname`:	Private generic functions
	`l-realname`:	Private generic functions
	`l-username`:	Private generic functions
	`l-username`:	Private generic functions
	`last-pong`:	Private generic functions
	`last-pong`:	Private generic functions
	`last-sexp-field`:	Private ordinary functions
	`log-daemon-message`:	Private ordinary functions
	`log-disconnection`:	Private ordinary functions
	`log-file-path`:	Public generic functions
	`log-file-path`:	Public generic functions
	`log-file-path`:	Public generic functions
	`log-file-path`:	Public generic functions
	`log-file-path`:	Public generic functions
	`log-file-path`:	Public generic functions
	`log-file-path-utime`:	Private ordinary functions
	`log-reconnection`:	Private ordinary functions
	`logging-stream`:	Private generic functions
	`logging-stream`:	Private generic functions

M
	`Macro, with-decoding`:	Private macros
	`make-a-channel`:	Private ordinary functions
	`make-channels`:	Private ordinary functions
	`make-output-name`:	Private ordinary functions
	`make-output-name-utime`:	Private ordinary functions
	`Method, %output-event`:	Private generic functions
	`Method, %output-event`:	Private generic functions
	`Method, %output-event`:	Private generic functions
	`Method, %output-event`:	Private generic functions
	`Method, (setf channel-names)`:	Private generic functions
	`Method, (setf channels)`:	Public standalone methods
	`Method, (setf connection)`:	Public standalone methods
	`Method, (setf current-output-names)`:	Private generic functions
	`Method, (setf handler)`:	Private generic functions
	`Method, (setf last-pong)`:	Private generic functions
	`Method, (setf monitor-events)`:	Private generic functions
	`Method, (setf warning-message-utime)`:	Private generic functions
	`Method, async`:	Private generic functions
	`Method, c-name`:	Private generic functions
	`Method, channel-names`:	Private generic functions
	`Method, channels`:	Public standalone methods
	`Method, connection`:	Public standalone methods
	`Method, current-output-names`:	Private generic functions
	`Method, formats`:	Private generic functions
	`Method, handler`:	Private generic functions
	`Method, l-nickname`:	Private generic functions
	`Method, l-realname`:	Private generic functions
	`Method, l-username`:	Private generic functions
	`Method, last-pong`:	Private generic functions
	`Method, log-file-path`:	Public generic functions
	`Method, log-file-path`:	Public generic functions
	`Method, log-file-path`:	Public generic functions
	`Method, log-file-path`:	Public generic functions
	`Method, log-file-path`:	Public generic functions
	`Method, logging-stream`:	Private generic functions
	`Method, monitor-events`:	Private generic functions
	`Method, output-root`:	Private generic functions
	`Method, password`:	Public standalone methods
	`Method, port`:	Private generic functions
	`Method, print-object`:	Public standalone methods
	`Method, private-log`:	Private generic functions
	`Method, private-log-stream`:	Private generic functions
	`Method, server`:	Private generic functions
	`Method, streams`:	Private generic functions
	`Method, unichannel`:	Private generic functions
	`Method, unknown-log`:	Private generic functions
	`Method, unknown-log-stream`:	Private generic functions
	`Method, user-output`:	Private generic functions
	`Method, warning-message-utime`:	Private generic functions
	`Method, write-file-footer`:	Private generic functions
	`Method, write-file-header`:	Private generic functions
	`mode-hook`:	Private ordinary functions
	`monitor-events`:	Private generic functions
	`monitor-events`:	Private generic functions
	`monitor-once`:	Private ordinary functions

N
	`need-user-address?`:	Private ordinary functions
	`nick-hook`:	Private ordinary functions
	`notice-hook`:	Private ordinary functions

O
	`output-event`:	Private ordinary functions
	`output-event-for-a-stream`:	Private ordinary functions
	`output-root`:	Private generic functions
	`output-root`:	Private generic functions

P
	`part-hook`:	Private ordinary functions
	`password`:	Public standalone methods
	`ping-hook`:	Private ordinary functions
	`pong-hook`:	Private ordinary functions
	`port`:	Private generic functions
	`port`:	Private generic functions
	`posix-time-to-utime`:	Private ordinary functions
	`print-object`:	Public standalone methods
	`private-log`:	Private generic functions
	`private-log`:	Private generic functions
	`private-log-stream`:	Private generic functions
	`private-log-stream`:	Private generic functions
	`privmsg-hook`:	Private ordinary functions

Q
	`quit-hook`:	Private ordinary functions
	`quit-with-timeout`:	Private ordinary functions

R
	`remove-channel-logger`:	Public ordinary functions
	`remove-hook-logger`:	Public ordinary functions
	`remove-logger`:	Public ordinary functions
	`rpl_endofnames-hook`:	Private ordinary functions
	`rpl_namreply-hook`:	Private ordinary functions
	`rpl_topic-hook`:	Private ordinary functions
	`rpl_topicwhotime-hook`:	Private ordinary functions

S
	`server`:	Private generic functions
	`server`:	Private generic functions
	`start-logger`:	Private ordinary functions
	`streams`:	Private generic functions
	`streams`:	Private generic functions

T
	`topic-hook`:	Private ordinary functions

U
	`unichannel`:	Private generic functions
	`unichannel`:	Private generic functions
	`unknown-log`:	Private generic functions
	`unknown-log`:	Private generic functions
	`unknown-log-stream`:	Private generic functions
	`unknown-log-stream`:	Private generic functions
	`user-address`:	Private ordinary functions
	`user-output`:	Private generic functions
	`user-output`:	Private generic functions

W
	`warning-hook`:	Private ordinary functions
	`warning-message-utime`:	Private generic functions
	`warning-message-utime`:	Private generic functions
	`with-decoding`:	Private macros
	`write-file-footer`:	Private generic functions
	`write-file-footer`:	Private generic functions
	`write-file-header`:	Private generic functions
	`write-file-header`:	Private generic functions

Jump to:	% ( A C D E F G H I J K L M N O P Q R S T U W

A.3 Variables

Jump to:	* + A C F H L M N O P R S U W

	Index Entry	Section

*
	`daemon-monitor-process`:	Private special variables
	`loggers`:	Public special variables
	`msg`:	Private special variables
	`timeout`:	Private special variables
	`user-address-scanner`:	Private special variables
	`warning-message-utime`:	Private special variables

+
	`+posix-epoch+`:	Private constants

A
	`async`:	Private classes

C
	`channel-names`:	Private classes
	`channels`:	Private classes
	`connection`:	Private classes
	`Constant, +posix-epoch+`:	Private constants
	`current-output-names`:	Private classes

F
	`formats`:	Private classes

H
	`handler`:	Private classes

L
	`last-pong`:	Private classes
	`logging-stream`:	Private classes

M
	`monitor-events`:	Private classes

N
	`name`:	Private classes
	`nick`:	Private classes

O
	`output-root`:	Private classes

P
	`password`:	Private classes
	`port`:	Private classes
	`private-log`:	Private classes
	`private-log-stream`:	Private classes

R
	`realname`:	Private classes

S
	`server`:	Private classes
	`Slot, async`:	Private classes
	`Slot, channel-names`:	Private classes
	`Slot, channels`:	Private classes
	`Slot, connection`:	Private classes
	`Slot, current-output-names`:	Private classes
	`Slot, formats`:	Private classes
	`Slot, handler`:	Private classes
	`Slot, last-pong`:	Private classes
	`Slot, logging-stream`:	Private classes
	`Slot, monitor-events`:	Private classes
	`Slot, name`:	Private classes
	`Slot, nick`:	Private classes
	`Slot, output-root`:	Private classes
	`Slot, password`:	Private classes
	`Slot, port`:	Private classes
	`Slot, private-log`:	Private classes
	`Slot, private-log-stream`:	Private classes
	`Slot, realname`:	Private classes
	`Slot, server`:	Private classes
	`Slot, streams`:	Private classes
	`Slot, unichannel`:	Private classes
	`Slot, unknown-log`:	Private classes
	`Slot, unknown-log-stream`:	Private classes
	`Slot, user-output`:	Private classes
	`Slot, username`:	Private classes
	`Slot, warning-message-utime`:	Private classes
	`Special Variable, daemon-monitor-process`:	Private special variables
	`Special Variable, loggers`:	Public special variables
	`Special Variable, msg`:	Private special variables
	`Special Variable, timeout`:	Private special variables
	`Special Variable, user-address-scanner`:	Private special variables
	`Special Variable, warning-message-utime`:	Private special variables
	`streams`:	Private classes

U
	`unichannel`:	Private classes
	`unknown-log`:	Private classes
	`unknown-log-stream`:	Private classes
	`user-output`:	Private classes
	`username`:	Private classes

W
	`warning-message-utime`:	Private classes

Jump to:	* + A C F H L M N O P R S U W

A.4 Data types

Jump to:	C F I L P S

	Index Entry	Section

C
	`Class, log-channel`:	Private classes
	`Class, logger`:	Private classes

F
	`File, irc-logger.asd`:	The irc-logger/irc-logger․asd file
	`File, logger.lisp`:	The irc-logger/logger․lisp file
	`File, package.lisp`:	The irc-logger/package․lisp file

I
	`irc-logger`:	The irc-logger system
	`irc-logger`:	The irc-logger package
	`irc-logger-system`:	The irc-logger-system package
	`irc-logger.asd`:	The irc-logger/irc-logger․asd file

L
	`log-channel`:	Private classes
	`logger`:	Private classes
	`logger.lisp`:	The irc-logger/logger․lisp file

P
	`Package, irc-logger`:	The irc-logger package
	`Package, irc-logger-system`:	The irc-logger-system package
	`package.lisp`:	The irc-logger/package․lisp file

S
	`System, irc-logger`:	The irc-logger system

Jump to:	C F I L P S

The irc-logger Reference Manual

The irc-logger Reference Manual

Table of Contents

1 Systems

1.1 irc-logger

2 Files

2.1 Lisp

2.1.1 irc-logger/irc-logger.asd

2.1.2 irc-logger/package.lisp

2.1.3 irc-logger/logger.lisp

3 Packages

3.1 irc-logger-system

3.2 irc-logger

4 Definitions

4.1 Public Interface

4.1.1 Special variables

4.1.2 Ordinary functions

4.1.3 Generic functions

4.1.4 Standalone methods

4.2 Internals

4.2.1 Constants

4.2.2 Special variables

4.2.3 Macros

4.2.4 Ordinary functions

4.2.5 Generic functions

4.2.6 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `irc-logger`

2.1.1 `irc-logger/irc-logger.asd`

2.1.2 `irc-logger/package.lisp`

2.1.3 `irc-logger/logger.lisp`

3.1 `irc-logger-system`

3.2 `irc-logger`