The irc-logger Reference Manual

This is the irc-logger Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:02:00 2018 GMT+0.

1 Systems

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

1.1 `irc-logger`

Dependencies

cl-irc
cl-ppcre

Source

irc-logger.asd (file)

Components

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

2 Files

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

2.1 Lisp

2.1.1 `irc-logger.asd`

Location: irc-logger.asd
Systems: irc-logger (system)
Packages: irc-logger-system

2.1.2 `irc-logger/package.lisp`

Parent: irc-logger (system)
Location: package.lisp
Packages: irc-logger

2.1.3 `irc-logger/logger.lisp`

Dependency

package.lisp (file)

Parent

irc-logger (system)

Location

logger.lisp

Exported Definitions

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

Internal Definitions

%is-connected (function)
%log-file-path (function)
%output-event (generic function)
%output-event (method)
%output-event (method)
%output-event (method)
%output-event (method)
*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 (method)
attempt-reconnection (function)
c-name (method)
canonicalize-channel-name (function)
channel-names (method)
(setf channel-names) (method)
create-logger (function)
current-output-names (method)
(setf current-output-names) (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 (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 (method)
(setf handler) (method)
invite-hook (function)
is-connected (function)
is-unichannel-output (function)
join-hook (function)
kick-hook (function)
kill-hook (function)
l-nickname (method)
l-realname (method)
l-username (method)
last-pong (method)
(setf last-pong) (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 (method)
make-a-channel (function)
make-channels (function)
make-output-name (function)
make-output-name-utime (function)
mode-hook (function)
monitor-events (method)
(setf monitor-events) (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 (method)
part-hook (function)
ping-hook (function)
pong-hook (function)
port (method)
posix-time-to-utime (function)
private-log (method)
private-log-stream (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 (method)
start-logger (function)
streams (method)
topic-hook (function)
unichannel (method)
unknown-log (method)
unknown-log-stream (method)
user-address (function)
user-output (method)
warning-hook (function)
warning-message-utime (method)
(setf warning-message-utime) (method)
with-decoding (macro)
write-file-footer (generic function)
write-file-footer (method)
write-file-header (generic function)
write-file-header (method)

3 Packages

Packages are listed by definition order.

3.1 `irc-logger-system`

Source

irc-logger.asd

Use List

asdf/interface
common-lisp

3.2 `irc-logger`

Source

package.lisp (file)

Use List

cl-ppcre
cl-irc
common-lisp

Exported Definitions

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

Internal Definitions

%is-connected (function)
%log-file-path (function)
%output-event (generic function)
%output-event (method)
%output-event (method)
%output-event (method)
%output-event (method)
*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 function)
async (method)
attempt-reconnection (function)
c-name (generic function)
c-name (method)
canonicalize-channel-name (function)
channel-names (generic function)
channel-names (method)
(setf channel-names) (method)
(setf channel-names) (generic function)
create-logger (function)
current-output-names (generic function)
current-output-names (method)
(setf current-output-names) (method)
(setf current-output-names) (generic function)
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 function)
formats (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 (generic function)
handler (method)
(setf handler) (method)
(setf handler) (generic function)
invite-hook (function)
is-connected (function)
is-unichannel-output (function)
join-hook (function)
kick-hook (function)
kill-hook (function)
l-nickname (generic function)
l-nickname (method)
l-realname (generic function)
l-realname (method)
l-username (generic function)
l-username (method)
last-pong (generic function)
last-pong (method)
(setf last-pong) (method)
(setf last-pong) (generic function)
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 function)
logging-stream (method)
make-a-channel (function)
make-channels (function)
make-output-name (function)
make-output-name-utime (function)
mode-hook (function)
monitor-events (generic function)
monitor-events (method)
(setf monitor-events) (method)
(setf monitor-events) (generic function)
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 function)
output-root (method)
part-hook (function)
ping-hook (function)
pong-hook (function)
port (generic function)
port (method)
posix-time-to-utime (function)
private-log (generic function)
private-log (method)
private-log-stream (generic function)
private-log-stream (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 (generic function)
server (method)
start-logger (function)
streams (generic function)
streams (method)
topic-hook (function)
unichannel (generic function)
unichannel (method)
unknown-log (generic function)
unknown-log (method)
unknown-log-stream (generic function)
unknown-log-stream (method)
user-address (function)
user-output (generic function)
user-output (method)
warning-hook (function)
warning-message-utime (generic function)
warning-message-utime (method)
(setf warning-message-utime) (method)
(setf warning-message-utime) (generic function)
with-decoding (macro)
write-file-footer (generic function)
write-file-footer (method)
write-file-header (generic function)
write-file-header (method)

4 Definitions

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

4.1 Exported definitions

4.1.1 Special variables

Special Variable: *loggers*

List of active loggers.

Package: irc-logger
Source: logger.lisp (file)

4.1.2 Functions

Function: add-channel-logger LOGGER CHANNEL-NAME

Package: irc-logger
Source: logger.lisp (file)

Function: add-hook-logger LOGGER CLASS HOOK

Package: irc-logger
Source: logger.lisp (file)

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 (file)

Function: remove-channel-logger LOGGER CHANNEL-NAME

Package: irc-logger
Source: logger.lisp (file)

Function: remove-hook-logger LOGGER CLASS HOOK

Package: irc-logger
Source: logger.lisp (file)

Function: remove-logger NICK

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

Package: irc-logger
Source: logger.lisp (file)

4.1.3 Generic functions

Generic Function: log-file-path OUTPUT-ROOT CHANNEL-NAME YEAR MONTH DAY FORMAT

Package

irc-logger

Source

logger.lisp (file)

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.2 Internal definitions

4.2.1 Constants

Constant: +posix-epoch+

Package: irc-logger
Source: logger.lisp (file)

4.2.2 Special variables

Special Variable: *daemon-monitor-process*

Process of background monitor.

Package: irc-logger
Source: logger.lisp (file)

Special Variable: *msg*

Package: irc-logger
Source: logger.lisp (file)

Special Variable: *timeout*

Package: irc-logger
Source: logger.lisp (file)

Special Variable: *user-address-scanner*

Package: irc-logger
Source: logger.lisp (file)

Special Variable: *warning-message-utime*

Package: irc-logger
Source: logger.lisp (file)

4.2.3 Macros

Macro: with-decoding (UTIME &optional ZONE) &body BODY

Package: irc-logger
Source: logger.lisp (file)

4.2.4 Functions

Function: %is-connected LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: %log-file-path OUTPUT-ROOT CHANNEL-NAME YEAR MONTH DAY TYPE

Package: irc-logger
Source: logger.lisp (file)

Function: action-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: add-log-entry STREAM FMT &rest ARGS

Package: irc-logger
Source: logger.lisp (file)

Function: add-private-log-entry LOGGER FMT &rest ARGS

Package: irc-logger
Source: logger.lisp (file)

Function: attempt-reconnection LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: canonicalize-channel-name NAME

Package: irc-logger
Source: logger.lisp (file)

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 (file)

Function: daemon-monitor ()

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

Package: irc-logger
Source: logger.lisp (file)

Function: daemon-sleep SECONDS

Package: irc-logger
Source: logger.lisp (file)

Function: do-connect-and-join NICK SERVER PORT USERNAME REALNAME LOGGING-STREAM CHANNELS

Package: irc-logger
Source: logger.lisp (file)

Function: ensure-output-stream UTIME LOGGER CHANNEL ISTREAM

Ensures that *output-stream* is correct.

Package: irc-logger
Source: logger.lisp (file)

Function: ensure-output-stream-for-unichannel UTIME LOGGER CHANNEL ISTREAM

Package: irc-logger
Source: logger.lisp (file)

Function: error-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: find-channel-with-name LOGGER NAME

Package: irc-logger
Source: logger.lisp (file)

Function: find-logger-with-connection CONN

Package: irc-logger
Source: logger.lisp (file)

Function: find-logger-with-nick NICK

Package: irc-logger
Source: logger.lisp (file)

Function: format-date-time UTIME &key STREAM

Package: irc-logger
Source: logger.lisp (file)

Function: format-utime UTIME &optional ZONE

Package: irc-logger
Source: logger.lisp (file)

Function: get-format LOGGER ISTREAM

Package: irc-logger
Source: logger.lisp (file)

Function: get-output-name CHANNEL ISTREAM

Function: (setf get-output-name) VALUE CHANNEL ISTREAM

Package: irc-logger
Source: logger.lisp (file)

Function: get-private-log-stream LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: get-stream CHANNEL ISTREAM

Function: (setf get-stream) VALUE CHANNEL ISTREAM

Package: irc-logger
Source: logger.lisp (file)

Function: get-unknown-log-stream LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: invite-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: is-connected LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: is-unichannel-output USER-OUTPUT

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

Package: irc-logger
Source: logger.lisp (file)

Function: join-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: kick-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: kill-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: last-sexp-field TYPE MSG

Package: irc-logger
Source: logger.lisp (file)

Function: log-daemon-message LOGGER FMT &rest ARGS

Package: irc-logger
Source: logger.lisp (file)

Function: log-disconnection LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: log-file-path-utime OUTPUT-ROOT CHANNEL-NAME FORMAT UTIME

Package: irc-logger
Source: logger.lisp (file)

Function: log-reconnection LOGGER

Package: irc-logger
Source: logger.lisp (file)

Function: make-a-channel NAME FORMATS OUTPUT

Package: irc-logger
Source: logger.lisp (file)

Function: make-channels NAMES FORMATS OUTPUT

Package: irc-logger
Source: logger.lisp (file)

Function: make-output-name NAME YEAR MONTH DAY

Package: irc-logger
Source: logger.lisp (file)

Function: make-output-name-utime NAME UTIME

Package: irc-logger
Source: logger.lisp (file)

Function: mode-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: monitor-once ()

Package: irc-logger
Source: logger.lisp (file)

Function: need-user-address? TYPE

Package: irc-logger
Source: logger.lisp (file)

Function: nick-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: notice-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: output-event MSG TYPE CHANNEL-NAME &optional TEXT

Package: irc-logger
Source: logger.lisp (file)

Function: output-event-for-a-stream MSG TYPE CHANNEL TEXT LOGGER ISTREAM

Package: irc-logger
Source: logger.lisp (file)

Function: part-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: ping-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: pong-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: posix-time-to-utime TIME

Package: irc-logger
Source: logger.lisp (file)

Function: privmsg-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: quit-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: quit-with-timeout CONNECTION MSG

Package: irc-logger
Source: logger.lisp (file)

Function: rpl_endofnames-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: rpl_namreply-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: rpl_topic-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: rpl_topicwhotime-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: start-logger LOGGER ASYNC

Package: irc-logger
Source: logger.lisp (file)

Function: topic-hook MSG

Package: irc-logger
Source: logger.lisp (file)

Function: user-address MSG

Package: irc-logger
Source: logger.lisp (file)

Function: warning-hook MSG

Package: irc-logger
Source: logger.lisp (file)

4.2.5 Generic functions

Generic Function: %output-event FORMAT STREAM UTIME TYPE CHANNEL SOURCE TEXT MSG UNICHANNEL

Package

irc-logger

Source

logger.lisp (file)

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 Function: async OBJECT

Package

irc-logger

Methods

Method: async (LOGGER logger)

Whether to use async

Source: logger.lisp (file)

Generic Function: c-name OBJECT

Package

irc-logger

Methods

Method: c-name (LOG-CHANNEL log-channel)

Name of channel.

Source: logger.lisp (file)

Generic Function: channel-names OBJECT

Generic Function: (setf channel-names) NEW-VALUE OBJECT

Package

irc-logger

Methods

Method: channel-names (LOGGER logger)

Method: (setf channel-names) NEW-VALUE (LOGGER logger)

List of channel names.

Source: logger.lisp (file)

Generic Function: current-output-names OBJECT

Generic Function: (setf current-output-names) NEW-VALUE OBJECT

Package

irc-logger

Methods

Method: current-output-names (LOG-CHANNEL log-channel)

automatically generated reader method

Source: logger.lisp (file)

Method: (setf current-output-names) NEW-VALUE (LOG-CHANNEL log-channel)

automatically generated writer method

Source: logger.lisp (file)

Generic Function: formats OBJECT

Package

irc-logger

Methods

Method: formats (LOGGER logger)

A list of output formats.

Source: logger.lisp (file)

Generic Function: handler OBJECT

Generic Function: (setf handler) NEW-VALUE OBJECT

Package

irc-logger

Methods

Method: handler (LOGGER logger)

Method: (setf handler) NEW-VALUE (LOGGER logger)

Background handler process.

Source: logger.lisp (file)

Generic Function: l-nickname OBJECT

Package

irc-logger

Methods

Method: l-nickname (LOGGER logger)

Nickname of the bot.

Source: logger.lisp (file)

Generic Function: l-realname OBJECT

Package

irc-logger

Methods

Method: l-realname (LOGGER logger)

Realname for cl-irc

Source: logger.lisp (file)

Generic Function: l-username OBJECT

Package

irc-logger

Methods

Method: l-username (LOGGER logger)

Username for cl-irc

Source: logger.lisp (file)

Generic Function: last-pong OBJECT

Generic Function: (setf last-pong) NEW-VALUE OBJECT

Package

irc-logger

Methods

Method: last-pong (LOGGER logger)

Method: (setf last-pong) NEW-VALUE (LOGGER logger)

utime of last pong message

Source: logger.lisp (file)

Generic Function: logging-stream OBJECT

Package

irc-logger

Methods

Method: logging-stream (LOGGER logger)

logging-stream for cl-irc.

Source: logger.lisp (file)

Generic Function: monitor-events OBJECT

Generic Function: (setf monitor-events) NEW-VALUE OBJECT

Package

irc-logger

Methods

Method: monitor-events (LOGGER logger)

Method: (setf monitor-events) NEW-VALUE (LOGGER logger)

List of events for the monitor to process.

Source: logger.lisp (file)

Generic Function: output-root OBJECT

Package

irc-logger

Methods

Method: output-root (LOG-CHANNEL log-channel)

automatically generated reader method

Source: logger.lisp (file)

Generic Function: port OBJECT

Package

irc-logger

Methods

Method: port (LOGGER logger)

Connected IRC server’s port.

Source: logger.lisp (file)

Generic Function: private-log OBJECT

Package

irc-logger

Methods

Method: private-log (LOGGER logger)

Pathname of the private log file for the daemon.

Source: logger.lisp (file)

Generic Function: private-log-stream OBJECT

Package

irc-logger

Methods

Method: private-log-stream (LOGGER logger)

Stream of the private log file for the daemon.

Source: logger.lisp (file)

Generic Function: server OBJECT

Package

irc-logger

Methods

Method: server (LOGGER logger)

Connected IRC server.

Source: logger.lisp (file)

Generic Function: streams OBJECT

Package

irc-logger

Methods

Method: streams (LOG-CHANNEL log-channel)

List of output streams.

Source: logger.lisp (file)

Generic Function: unichannel OBJECT

Package

irc-logger

Methods

Method: unichannel (LOGGER logger)

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

Source: logger.lisp (file)

Generic Function: unknown-log OBJECT

Package

irc-logger

Methods

Method: unknown-log (LOGGER logger)

Pathname of the log file for unknown messages.

Source: logger.lisp (file)

Generic Function: unknown-log-stream OBJECT

Package

irc-logger

Methods

Method: unknown-log-stream (LOGGER logger)

Stream of the log file for unknown messages.

Source: logger.lisp (file)

Generic Function: user-output OBJECT

Package

irc-logger

Methods

Method: user-output (LOGGER logger)

Output parameter from user, maybe stream or pathname.

Source: logger.lisp (file)

Generic Function: warning-message-utime OBJECT

Generic Function: (setf warning-message-utime) NEW-VALUE OBJECT

Package

irc-logger

Methods

Method: warning-message-utime (LOGGER logger)

Method: (setf warning-message-utime) NEW-VALUE (LOGGER logger)

Time of last, potentially active, warning message.

Source: logger.lisp (file)

Generic Function: write-file-footer FORMAT CHANNEL-NAME STREAM

Package

irc-logger

Source

logger.lisp (file)

Methods

Method: write-file-footer FORMAT CHANNEL-NAME STREAM

Generic Function: write-file-header FORMAT CHANNEL-NAME STREAM

Package

irc-logger

Source

logger.lisp (file)

Methods

Method: write-file-header FORMAT CHANNEL-NAME STREAM

4.2.6 Classes

Class: log-channel ()

Package

irc-logger

Source

logger.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

current-output-names (method)
current-output-names (method)
output-root (method)
streams (method)
c-name (method)

Direct slots

Slot: name

Name of channel.

Initargs: :name
Readers: c-name (generic function)

Slot: streams

List of output streams.

Initargs: :streams
Readers: streams (generic function)

Slot: output-root

Initargs: :output-root
Readers: output-root (generic function)

Slot: current-output-names

Initargs: :current-output-names
Readers: current-output-names (generic function)
Writers: (setf current-output-names) (generic function)

Class: logger ()

Package

irc-logger

Source

logger.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

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

Direct slots

Slot: connection

IRC connection object.

Initargs: :connection
Readers: connection (generic function)
Writers: (setf connection) (generic function)

Slot: handler

Background handler process.

Readers: handler (generic function)
Writers: (setf handler) (generic function)

Slot: nick

Nickname of the bot.

Initargs: :nick
Readers: l-nickname (generic function)

Slot: password

Nickname’s nickserver password.

Initargs: :password
Readers: password (generic function)

Slot: server

Connected IRC server.

Initargs: :server
Readers: server (generic function)

Slot: port

Connected IRC server’s port.

Initargs: :port
Readers: port (generic function)

Slot: channel-names

List of channel names.

Initargs: :channel-names
Readers: channel-names (generic function)
Writers: (setf channel-names) (generic function)

Slot: realname

Realname for cl-irc

Initargs: :realname
Readers: l-realname (generic function)

Slot: username

Username for cl-irc

Initargs: :username
Readers: l-username (generic function)

Slot: logging-stream

logging-stream for cl-irc.

Initargs: :logging-stream
Readers: logging-stream (generic function)

Slot: channels

List of channels.

Initargs: :channels
Readers: channels (generic function)
Writers: (setf channels) (generic function)

Slot: user-output

Output parameter from user, maybe stream or pathname.

Initargs: :user-output
Readers: user-output (generic function)

Slot: unichannel

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

Type: boolean
Initargs: :unichannel
Readers: unichannel (generic function)

Slot: formats

A list of output formats.

Initargs: :formats
Readers: formats (generic function)

Slot: async

Whether to use async

Initargs: :async
Readers: async (generic function)

Slot: last-pong

utime of last pong message

Readers: last-pong (generic function)
Writers: (setf last-pong) (generic function)

Slot: private-log

Pathname of the private log file for the daemon.

Initargs: :private-log
Readers: private-log (generic function)

Slot: unknown-log

Pathname of the log file for unknown messages.

Initargs: :unknown-log
Readers: unknown-log (generic function)

Slot: private-log-stream

Stream of the private log file for the daemon.

Initargs: :private-log-stream
Readers: private-log-stream (generic function)

Slot: unknown-log-stream

Stream of the log file for unknown messages.

Initargs: :unknown-log-stream
Readers: unknown-log-stream (generic function)

Slot: monitor-events

List of events for the monitor to process.

Readers: monitor-events (generic function)
Writers: (setf monitor-events) (generic function)

Slot: warning-message-utime

Time of last, potentially active, warning message.

Readers: warning-message-utime (generic function)
Writers: (setf warning-message-utime) (generic function)

Appendix A Indexes

A.1 Concepts

Jump to:	F I L

	Index Entry	Section

F
	File, Lisp, `irc-logger.asd`:	The irc-logger<dot>asd file
	File, Lisp, `irc-logger/logger.lisp`:	The irc-logger/logger<dot>lisp file
	File, Lisp, `irc-logger/package.lisp`:	The irc-logger/package<dot>lisp file

I
	`irc-logger.asd`:	The irc-logger<dot>asd file
	`irc-logger/logger.lisp`:	The irc-logger/logger<dot>lisp file
	`irc-logger/package.lisp`:	The irc-logger/package<dot>lisp file

L
	Lisp File, `irc-logger.asd`:	The irc-logger<dot>asd file
	Lisp File, `irc-logger/logger.lisp`:	The irc-logger/logger<dot>lisp file
	Lisp File, `irc-logger/package.lisp`:	The irc-logger/package<dot>lisp file

Jump to:	F I L

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`:	Internal functions
	`%log-file-path`:	Internal functions
	`%output-event`:	Internal generic functions
	`%output-event`:	Internal generic functions
	`%output-event`:	Internal generic functions
	`%output-event`:	Internal generic functions
	`%output-event`:	Internal generic functions

(
	`(setf channel-names)`:	Internal generic functions
	`(setf channel-names)`:	Internal generic functions
	`(setf current-output-names)`:	Internal generic functions
	`(setf current-output-names)`:	Internal generic functions
	`(setf get-output-name)`:	Internal functions
	`(setf get-stream)`:	Internal functions
	`(setf handler)`:	Internal generic functions
	`(setf handler)`:	Internal generic functions
	`(setf last-pong)`:	Internal generic functions
	`(setf last-pong)`:	Internal generic functions
	`(setf monitor-events)`:	Internal generic functions
	`(setf monitor-events)`:	Internal generic functions
	`(setf warning-message-utime)`:	Internal generic functions
	`(setf warning-message-utime)`:	Internal generic functions

A
	`action-hook`:	Internal functions
	`add-channel-logger`:	Exported functions
	`add-hook-logger`:	Exported functions
	`add-log-entry`:	Internal functions
	`add-logger`:	Exported functions
	`add-private-log-entry`:	Internal functions
	`async`:	Internal generic functions
	`async`:	Internal generic functions
	`attempt-reconnection`:	Internal functions

C
	`c-name`:	Internal generic functions
	`c-name`:	Internal generic functions
	`canonicalize-channel-name`:	Internal functions
	`channel-names`:	Internal generic functions
	`channel-names`:	Internal generic functions
	`create-logger`:	Internal functions
	`current-output-names`:	Internal generic functions
	`current-output-names`:	Internal generic functions

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

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

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

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

H
	`handler`:	Internal generic functions
	`handler`:	Internal generic functions

I
	`invite-hook`:	Internal functions
	`is-connected`:	Internal functions
	`is-unichannel-output`:	Internal functions

J
	`join-hook`:	Internal functions

K
	`kick-hook`:	Internal functions
	`kill-hook`:	Internal functions

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

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

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

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

P
	`part-hook`:	Internal functions
	`ping-hook`:	Internal functions
	`pong-hook`:	Internal functions
	`port`:	Internal generic functions
	`port`:	Internal generic functions
	`posix-time-to-utime`:	Internal functions
	`private-log`:	Internal generic functions
	`private-log`:	Internal generic functions
	`private-log-stream`:	Internal generic functions
	`private-log-stream`:	Internal generic functions
	`privmsg-hook`:	Internal functions

Q
	`quit-hook`:	Internal functions
	`quit-with-timeout`:	Internal functions

R
	`remove-channel-logger`:	Exported functions
	`remove-hook-logger`:	Exported functions
	`remove-logger`:	Exported functions
	`rpl_endofnames-hook`:	Internal functions
	`rpl_namreply-hook`:	Internal functions
	`rpl_topic-hook`:	Internal functions
	`rpl_topicwhotime-hook`:	Internal functions

S
	`server`:	Internal generic functions
	`server`:	Internal generic functions
	`start-logger`:	Internal functions
	`streams`:	Internal generic functions
	`streams`:	Internal generic functions

T
	`topic-hook`:	Internal functions

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

W
	`warning-hook`:	Internal functions
	`warning-message-utime`:	Internal generic functions
	`warning-message-utime`:	Internal generic functions
	`with-decoding`:	Internal macros
	`write-file-footer`:	Internal generic functions
	`write-file-footer`:	Internal generic functions
	`write-file-header`:	Internal generic functions
	`write-file-header`:	Internal 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`:	Internal special variables
	`loggers`:	Exported special variables
	`msg`:	Internal special variables
	`timeout`:	Internal special variables
	`user-address-scanner`:	Internal special variables
	`warning-message-utime`:	Internal special variables

+
	`+posix-epoch+`:	Internal constants

A
	`async`:	Internal classes

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

F
	`formats`:	Internal classes

H
	`handler`:	Internal classes

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

M
	`monitor-events`:	Internal classes

N
	`name`:	Internal classes
	`nick`:	Internal classes

O
	`output-root`:	Internal classes

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

R
	`realname`:	Internal classes

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

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

W
	`warning-message-utime`:	Internal classes

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

A.4 Data types

Jump to:	C I L P S

	Index Entry	Section

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

I
	`irc-logger`:	The irc-logger system
	`irc-logger`:	The irc-logger package
	`irc-logger-system`:	The irc-logger-system package

L
	`log-channel`:	Internal classes
	`logger`:	Internal classes

P
	`Package, irc-logger`:	The irc-logger package
	`Package, irc-logger-system`:	The irc-logger-system package

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

Jump to:	C I L P S

• Systems:		The systems documentation
• Files:		The files documentation
• Packages:		The packages documentation
• Definitions:		The symbols documentation
• Indexes:		Concepts, functions, variables and data types

• Internal constants:
• Internal special variables:
• Internal macros:
• Internal functions:
• Internal generic functions:
• Internal classes:

• Concept index:
• Function index:
• Variable index:
• Data type index:

• The irc-logger.asd file:
• The irc-logger/package.lisp file:
• The irc-logger/logger.lisp file:

• The irc-logger-system package:
• The irc-logger package:

• Exported special variables:
• Exported functions:
• Exported generic functions:

The irc-logger Reference Manual

Table of Contents

The irc-logger Reference Manual

1 Systems

1.1 irc-logger

2 Files

2.1 Lisp

2.1.1 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 Exported definitions

4.1.1 Special variables

4.1.2 Functions

4.1.3 Generic functions

4.2 Internal definitions

4.2.1 Constants

4.2.2 Special variables

4.2.3 Macros

4.2.4 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.asd`

2.1.2 `irc-logger/package.lisp`

2.1.3 `irc-logger/logger.lisp`

3.1 `irc-logger-system`

3.2 `irc-logger`