The colleen Reference Manual

Table of Contents

The colleen Reference Manual

This is the colleen Reference Manual, version 2.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:02:14 2019 GMT+0.

1 Introduction

About Colleen

Colleen is a relatively large IRC bot framework with support for event handling, encapsulation through modules, command parsing, threading and more. However, it is also usable as a direct IRC bot straight away thanks to a plethora of modules that are included by default and should provide most of the functionality you might want out of a bot.

Colleen is no longer maintained and has been superseded by Maiden.

How to Use Colleen as a Bot

Load Colleen through Quicklisp or ASDF:

(ql:quickload :colleen)
(in-package :colleen)

And start it up!

(startup)

Colleen is managed through a bunch of configuration files. By default it has servers configured for TymoonNET and Freenode. First though, let's change the default nick to something that is less likely to be taken already. With that done we'll save our configuration to a file.

(setf (bot-config :servers :default :nick) "Colleek")
(save-config)

This should save a file called colleen.uc.lisp to a config folder underneath the Colleen root folder. When you open the file you'll see it is organised using a lisp-like syntax, with extension for hash-tables. Another thing you'll notice is that all strings are preceded with a -. This is a necessary evil in order to serialise certain data types to string and be able to serialise them back. For more information on how the configuration storage works, see Universal-Config. Using the configuration file you can set the servers to connect to by default, which channels to join and so on. For now we'll do it manually with some code.

(connect :freenode)

If all works nicely, you'll see some log messages informing you of the connection. You should now be able to fire up an IRC client to Freenode and start conversing with your bot. Since the essentials module is loaded by default, you can try commands like !time, or !echo hi. If you want to see what's going on behind the scene, you can change the logging level from :info to :trace:

(setf (v:repl-level) :trace)

This'll show you quite a bit of output, including pings and all forms of event handling. It'll likely be much too noisy, but it can be very useful for debugging purposes.

Since Colleen is not just a bot, but also a framework, we can use its functions to communicate ourselves.

(irc:privmsg "this-is-my-nick-here" "Hello REPL!" :server (server :freenode))

Obviously change the nick to your own first.

Colleen's functionality is managed through modules. By default the auth and essentials modules are loaded. You can load up more modules by putting them into the :MODULES list in the configuration, using the !module load command or directly using load-module.

(load-module :silly)

Loading a module won't make it active yet though. For that you need to start it first. You can use either the command !module start or the start-module function. If you put it into the configuration instead, it'll also automatically start it for you when you startup Colleen.

(start-module :silly)

Some modules like silly perform actions not on commands, but when certain things are said. In order to avoid causing unnecessary noise, you need to activate for a specific channel. You can usually do that with an activate sub command. In this case it would be !silly activate. When you try that now you will most likely be denied access. Colleen includes a simple permissions restriction in order to separate "dangerous administrative commands" from publicly available ones. The auth module that is present by default will authenticate users by either a simple password or through NickServ. First you need to put your nick on the list of recognised names though. The auth module has its separate configuration file that currently does not exist yet. Before setting that up, we'll simply bypass it by smuggling our nick directly onto the authenticated list:

(push "this-is-my-nick-here" (auth-users (get-server :freenode)))

You should now be able to invoke !silly activate and try it with saying something like how the hell. You can stop it any time by invoking !silly deactivate or stopping the module entirely !module stop silly.

Now in order to get the authentication set up properly, we first need the configuration file to appear. In order to manage configuration files for modules you can use !module storage save auth or save-storage.

(save-storage (module :auth))

The file will most likely just contain a table stub. Change it to something like this to make yourself authenticate-able:

{EQL
:LOGINS {EQL
         :this-is-my-nick-here "-myPasswordGOESheeere!"}}

Don't forget the necessary "-" before your password. Next you can load the configuration back in using !module storage load auth or load-storage.

(load-storage (module :auth))

Using !logout you can remove yourself from the authenticated list. If your nick is registered with NickServ you should now be able to use just !login to log back in, or alternatively pass your password along.

Since everything is managed through configuration files you can create a running standalone bot by simply starting your lisp implementation with a file containing something akin to the following in it

(ql:quickload :colleen)
(funcall (find-symbol "STARTUP" "COLLEEN"))

Colleen has a lot more to offer of course, but I think this should suffice as a setup guide. For all the different modules, have a look at the modules/ directory in Colleen's root. The commands each of them offer should be clear enough in the source, but if you prefer a more straight forward explanation of all the public functionality, there is a guide here. You can of course also experiment with the functionality without setting up your own and just using the live instance as mentioned in the guide.

To shut Colleen down again nicely, simply invoke shutdown.

Using Colleen as a Framework

Functions are encapsulated in modules. A module requires a package and a define-module form within that package. A simple module stub would look something like this:

(in-package #:colleen)
(defpackage #:my-module
  (:use #:cl #:colleen #:events))
(in-package #:my-module)

(define-module my-module () ())

The define-module form is the same as defclass, with some additional side effects to register it with the system. The extra package is necessary in order to provide an implicit environment to carry the current module and make commands like define-command and define-handler shorter. It is not strictly necessary to use a separate package per module, but it certainly is a good idea.

Generally you'll want to use define-command, define-group and define-handler, although there exist more low-level constructs that allow you to do the same with more control over the output.

(define-group my-commands :documentation "A collection of commands for my test module!")

(define-command (my-commands test) () (:documentation "Simply performs a test.")
  (respond event "Testing, testing, 1, 2, 3.")

(define-handler (privmsg-event event) ()
  (v:info :my-module "Got a privmsg by ~a: ~a" (nick event) (message event)))

By default within a define-command or define-handler body, the symbols event and module are bound to the current event instance and the current module instance. Furthermore, the module's storage is bound to uc:*config*. Especially the configuration is useful, as you don't need to handle that manually yourself. Colleen automatically provides storage for you and will save and load it accordingly when your module is loaded or started. Accessing the configuration happens through Universal-Config's config-tree, which is setf-able. For more information on how serialising and accessing and all that works, see the Universal-Config documentation. For now we'll use this to implement a simple last-message function:

(define-handler (privmsg-event event) ()
  (unless (command-p (message event))
    (setf (uc:config-tree :last-message) (message event))))

(define-command last-message () ()
  (respond event (uc:config-tree :last-message)))

Aside from commands and handlers, Colleen also includes a timer functionality in order to schedule tasks. See define-timer and schedule-timer. Generally having a look at all the already existing modules should give a good idea on how to make your own, they usually aren't big and shouldn't be hard to understand in what they do.

2 Systems

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

2.1 colleen

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/colleen/

Source Control

(:git "https://github.com/shinmera/colleen.git")

Bug Tracker

https://github.com/Shinmera/colleen/issues

License

Artistic

Description

IRC bot with a modular framework.

Version

2.2.0

Dependencies

• bordeaux-threads
• universal-config
• verbose
• usocket
• flexi-streams
• uuid
• cl-ppcre
• trivial-arguments

Source

colleen.asd (file)

Components

• package.lisp (file)
• globals.lisp (file)
• conditions.lisp (file)
• irc-codes.lisp (file)
• config.lisp (file)
• toolkit.lisp (file)
• module.lisp (file)
• module-storage.lisp (file)
• event.lisp (file)
• event-priority.lisp (file)
• event-handler.lisp (file)
• client.lisp (file)
• command-handler.lisp (file)
• time-handler.lisp (file)
• irc-commands.lisp (file)
• irc-events.lisp (file)
• asdf-extra.lisp (file)
• launcher.lisp (file)
• modules (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 colleen/modules

Dependency

launcher.lisp (file)

Parent

colleen (system)

Location

modules/

Components

• system-definitions.lisp (file)
• core.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 colleen.asd

Location

colleen.asd

Systems

colleen (system)

4.1.2 colleen/package.lisp

Parent

colleen (system)

Location

package.lisp

Packages

• irc
• colleen
• events

4.1.3 colleen/globals.lisp

Dependency

package.lisp (file)

Parent

colleen (system)

Location

globals.lisp

Exported Definitions

• *debugger* (special variable)
• *irc-message-limit* (special variable)
• *privmsg-line-limit* (special variable)
• *server-encoding* (special variable)

4.1.4 colleen/conditions.lisp

Dependency

globals.lisp (file)

Parent

colleen (system)

Location

conditions.lisp

Exported Definitions

• argslist (method)
• command (method)
• connection-failed (condition)
• disconnect (condition)
• event (method)
• expected (method)
• failed-server (method)
• group (method)
• implicit-group-definition (condition)
• initial-error (method)
• invalid-arguments (condition)
• message (method)
• message-too-long (condition)
• module-error (condition)
• module-stop (condition)
• module-system-not-found (condition)
• name (method)
• network-error (condition)
• not-authorized (condition)
• ping-timeout (condition)

Internal Definitions

limit-form (method)

4.1.5 colleen/irc-codes.lisp

Dependency

conditions.lisp (file)

Parent

colleen (system)

Location

irc-codes.lisp

Exported Definitions

• *reply-code-map* (special variable)
• reply->keyword (generic function)
• reply->keyword (method)
• reply->keyword (method)

4.1.6 colleen/config.lisp

Dependency

irc-codes.lisp (file)

Parent

colleen (system)

Location

config.lisp

Exported Definitions

• *config* (special variable)
• *config-directory* (special variable)
• *config-file* (special variable)
• *default-config-file* (special variable)
• bot-config (function)
• (setf bot-config) (function)
• load-config (function)
• save-config (function)
• server-config (function)

Internal Definitions

*sample-config-file* (special variable)

4.1.7 colleen/toolkit.lisp

Dependency

config.lisp (file)

Parent

colleen (system)

Location

toolkit.lisp

Exported Definitions

• break-string (function)
• color-entities (function)
• format-message (function)
• fstd-message (function)
• mirc-color->name (function)
• standard-message (function)
• strip-colors (function)

Internal Definitions

• *formatting-regex* (special variable)
• *mirc-color-map* (special variable)
• *mirc-color-regex* (special variable)
• build-lambda-call (function)
• ensure-list (function)
• escape-regex-symbols (function)
• extract-lambda-vars (function)
• flatten-lambda-list (function)
• force-release-lock (function)
• lambda-keyword-p (function)
• lambda-list->string (function)
• required-lambda-vars (function)
• with-repeating-restart (macro)
• xor (macro)

4.1.8 colleen/module.lisp

Dependency

toolkit.lisp (file)

Parent

colleen (system)

Location

module.lisp

Exported Definitions

• *bot-modules* (special variable)
• *current-module* (special variable)
• active (method)
• active (method)
• active (method)
• (setf active) (method)
• define-module (macro)
• get-current-module (function)
• get-current-module-name (function)
• get-module (function)
• module (function)
• (setf module) (generic function)
• (setf module) (method)
• (setf module) (generic function)
• (setf module) (method)
• module (class)
• module-thread (function)
• (setf module-thread) (generic function)
• (setf module-thread) (method)
• (setf module-thread) (generic function)
• (setf module-thread) (method)
• name (method)
• print-module-thread-stats (function)
• remove-module-thread (function)
• start (generic function)
• start (method)
• start (method)
• start-module (function)
• stop (generic function)
• stop (method)
• stop (method)
• stop-module (function)
• stop-module-thread (function)
• storage (method)
• (setf storage) (method)
• sweep-all-module-threads (function)
• sweep-module-threads (function)
• threads (method)
• threads (method)
• threads (method)
• (setf threads) (method)
• to-module-name (generic function)
• to-module-name (method)
• to-module-name (method)
• to-module-name (method)
• with-module (macro)
• with-module-lock (macro)
• with-module-thread (macro)

Internal Definitions

• generalize-module-accessor (macro)
• package-symbol (function)

4.1.9 colleen/module-storage.lisp

Dependency

module.lisp (file)

Parent

colleen (system)

Location

module-storage.lisp

Exported Definitions

• load-storage (generic function)
• load-storage (method)
• module-config-path (function)
• save-storage (generic function)
• save-storage (method)
• with-module-storage (macro)

4.1.10 colleen/event.lisp

Dependency

module-storage.lisp (file)

Parent

colleen (system)

Location

event.lisp

Exported Definitions

• *event-map* (special variable)
• arguments (method)
• cancelled (method)
• (setf cancelled) (method)
• channel (method)
• (setf channel) (method)
• channel (method)
• channel-event (class)
• command-event (class)
• define-event (macro)
• dispatched (method)
• (setf dispatched) (method)
• event (class)
• generated-command-event (class)
• hostmask (method)
• make-event (function)
• message (method)
• message (method)
• (setf message) (method)
• (setf message) (method)
• nick (method)
• (setf nick) (method)
• nick (method)
• output-stream (method)
• (setf output-stream) (method)
• prefix (method)
• respond (generic function)
• respond (method)
• respond (method)
• respond (method)
• send-event (class)
• server (method)
• user-event (class)
• username (method)

Internal Definitions

• *user-regex* (special variable)
• arguments-bind (macro)
• cancel (function)
• handled (method)
• (setf handled) (method)

4.1.11 colleen/event-priority.lisp

Dependency

event.lisp (file)

Parent

colleen (system)

Location

event-priority.lisp

Exported Definitions

• *priority-names* (special variable)
• *priority-nums* (special variable)
• priority-name (function)
• (setf priority-name) (generic function)
• (setf priority-name) (method)
• (setf priority-name) (generic function)
• (setf priority-name) (method)
• priority-num (function)
• (setf priority-num) (generic function)
• (setf priority-num) (method)
• (setf priority-num) (generic function)
• (setf priority-num) (method)

4.1.12 colleen/event-handler.lisp

Dependency

event-priority.lisp (file)

Parent

colleen (system)

Location

event-handler.lisp

Exported Definitions

• *evt-map* (special variable)
• *evt-priority-map* (special variable)
• apropos-event-handler (generic function)
• apropos-event-handler (method)
• apropos-event-handler (method)
• define-handler (macro)
• dispatch (generic function)
• dispatch (method)
• docstring (method)
• (setf docstring) (method)
• event-handler (function)
• (setf event-handler) (generic function)
• (setf event-handler) (method)
• (setf event-handler) (generic function)
• (setf event-handler) (method)
• event-handler (class)
• event-type (method)
• (setf event-type) (method)
• generate-handler-priority-cache (function)
• handler-function (method)
• (setf handler-function) (method)
• identifier (method)
• (setf identifier) (method)
• priority (method)
• (setf priority) (method)
• remove-event-handler (function)
• set-handler-function (function)

4.1.13 colleen/client.lisp

Dependency

event-handler.lisp (file)

Parent

colleen (system)

Location

client.lisp

Exported Definitions

• *current-server* (special variable)
• *servers* (special variable)
• add-to-auth (function)
• auth-p (function)
• auth-users (method)
• (setf auth-users) (method)
• channels (method)
• (setf channels) (method)
• connect (generic function)
• connect (method)
• connect (method)
• connect (method)
• disconnect (generic function)
• disconnect (method)
• disconnect (method)
• disconnect (method)
• ensure-server (function)
• get-server (function)
• host (method)
• (setf host) (method)
• name (method)
• (setf name) (method)
• nick (method)
• (setf nick) (method)
• password (method)
• (setf password) (method)
• port (method)
• (setf port) (method)
• realname (method)
• (setf realname) (method)
• reconnect (generic function)
• reconnect (method)
• reconnect (method)
• remove-from-auth (function)
• server (method)
• server (class)
• username (method)
• (setf username) (method)

Internal Definitions

• *irc-message-regex* (special variable)
• call-with-reconnect-handler (function)
• handle (function)
• last-ping (method)
• (setf last-ping) (method)
• make-server-thread (function)
• ping-loop (function)
• ping-thread (method)
• (setf ping-thread) (method)
• read-loop (function)
• read-thread (method)
• (setf read-thread) (method)
• receive-raw-message (function)
• restart-thread (method)
• (setf restart-thread) (method)
• socket (method)
• (setf socket) (method)
• socket-stream (method)
• (setf socket-stream) (method)
• with-reconnect-handler (macro)

4.1.14 colleen/command-handler.lisp

Dependency

client.lisp (file)

Parent

colleen (system)

Location

command-handler.lisp

Exported Definitions

• *cmd-map* (special variable)
• *cmd-priority-array* (special variable)
• apropos-command-handler (generic function)
• apropos-command-handler (method)
• apropos-command-handler (method)
• apropos-command-handler (method)
• apropos-command-handler (method)
• arguments (method)
• (setf arguments) (method)
• command-handler (function)
• (setf command-handler) (generic function)
• (setf command-handler) (method)
• (setf command-handler) (generic function)
• (setf command-handler) (method)
• command-handler (class)
• command-p (function)
• define-command (macro)
• define-group (macro)
• dispatch-command (generic function)
• dispatch-command (method)
• do-matching-command-handlers (macro)
• docstring (method)
• (setf docstring) (method)
• group-handler (class)
• handler-function (method)
• (setf handler-function) (method)
• identifier (method)
• (setf identifier) (method)
• pattern (method)
• (setf pattern) (method)
• priority (method)
• (setf priority) (method)
• relay-command (function)
• remove-command-handler (function)
• scanner (method)
• (setf scanner) (method)
• set-command-function (function)
• simulate-command (function)
• subcommands (method)
• (setf subcommands) (method)

Internal Definitions

• arguments-match-p (function)
• generate-command-priority-cache (function)
• group-command-handler (function)
• no-command-matched (function)
• read-command (function)

4.1.15 colleen/time-handler.lisp

Dependency

command-handler.lisp (file)

Parent

colleen (system)

Location

time-handler.lisp

Exported Definitions

• *timer-map* (special variable)
• apropos-time-handler (generic function)
• apropos-time-handler (method)
• apropos-time-handler (method)
• arguments (method)
• (setf arguments) (method)
• define-timer (macro)
• docstring (method)
• (setf docstring) (method)
• handler-function (method)
• (setf handler-function) (method)
• handler-lock (method)
• (setf handler-lock) (method)
• identifier (method)
• (setf identifier) (method)
• launcher-function (method)
• (setf launcher-function) (method)
• module-launcher (function)
• parse-delay (generic function)
• parse-delay (method)
• parse-delay (method)
• remove-time-handler (function)
• reschedule-timer (function)
• schedule-timer (function)
• schedulings (method)
• (setf schedulings) (method)
• set-timer-function (function)
• simple-launcher (function)
• stop-time-handler (function)
• time-handler (function)
• (setf time-handler) (generic function)
• (setf time-handler) (method)
• (setf time-handler) (generic function)
• (setf time-handler) (method)
• time-handler (class)
• timer-type (method)
• (setf timer-type) (method)

Internal Definitions

• *unix-epoch-difference* (special variable)
• launch-timer (function)
• timer-timeout (function)

4.1.16 colleen/irc-commands.lisp

Dependency

time-handler.lisp (file)

Parent

colleen (system)

Location

irc-commands.lisp

Exported Definitions

• admin (function)
• away (function)
• broadcast (function)
• channel-mode (function)
• connect (function)
• error (function)
• info (function)
• invite (function)
• ison (function)
• join (function)
• kick (function)
• kill (function)
• links (function)
• list (function)
• names (function)
• nick (function)
• notice (function)
• oper (function)
• part (function)
• pass (function)
• ping (function)
• pong (function)
• privmsg (function)
• quit (function)
• rehash (function)
• restart (function)
• send-raw (function)
• server (function)
• squit (function)
• stats (function)
• summon (function)
• time (function)
• topic (function)
• trace (function)
• user (function)
• user-mode (function)
• userhost (function)
• users (function)
• version (function)
• wallops (function)
• who (function)
• whois (function)
• whowas (function)

Internal Definitions

raw (function)

4.1.17 colleen/irc-events.lisp

Dependency

irc-commands.lisp (file)

Parent

colleen (system)

Location

irc-events.lisp

Exported Definitions

• active-type (method)
• address (method)
• admin-email-event (class)
• admin-loc1-event (class)
• admin-loc2-event (class)
• admin-location (method)
• admin-location (method)
• admin-me-event (class)
• already-registered-event (class)
• authname (method)
• away-event (class)
• backstream-sendq (method)
• bad-channel-key-event (class)
• bad-channel-mask-event (class)
• bad-char-encoding-event (class)
• bad-mask-event (class)
• banid (method)
• banlist-end-event (class)
• banlist-event (class)
• banlist-full-event (class)
• banned-from-chan-event (class)
• bounce-event (class)
• byte-count (method)
• cannot-change-chanmode-event (class)
• cannot-change-servermode-event (class)
• cannot-change-umode-event (class)
• cannot-send-to-chan-event (class)
• cannot-send-to-nick-event (class)
• cannot-set-modes-event (class)
• cant-kill-server-event (class)
• chan-char (method)
• chan-modes (method)
• chan-open-event (class)
• chan-privs-needed-event (class)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel-full-event (class)
• channel-mode-event (class)
• channel-modes-with-params (method)
• channels (method)
• chanredir-event (class)
• charset (method)
• class-count (method)
• client-name (method)
• cmd-count (method)
• code (method)
• code (method)
• codes (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• comments (method)
• config-file (method)
• connect-freq (method)
• connection-address (method)
• created-event (class)
• debug-level (method)
• destination (method)
• disabled-event (class)
• email-address (method)
• erroneusnickname-event (class)
• etrace-event (class)
• etrace-full-event (class)
• exceptionmask (method)
• exceptlist-end-event (class)
• exceptlist-event (class)
• file (method)
• file-error-event (class)
• flags (method)
• flags (method)
• generic-end-event (class)
• global-users-event (class)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• help-end-event (class)
• help-start-event (class)
• help-txt-event (class)
• hop (method)
• hopcount (method)
• hopcount (method)
• hops (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host-hidden-event (class)
• host2 (method)
• hostmask (method)
• hostmask (method)
• hostmask (method)
• hostname (method)
• hostname (method)
• info-end-event (class)
• info-event (class)
• int (method)
• int (method)
• int (method)
• intc (method)
• ints (method)
• invited-event (class)
• invitee (method)
• invitelist-end-event (class)
• invitelist-event (class)
• invitemask (method)
• inviteonly-chan-event (class)
• inviting-event (class)
• ison-event (class)
• isupport-event (class)
• join-event (class)
• key-set-event (class)
• kick-event (class)
• knock-disabled-event (class)
• knock-dlvr-event (class)
• knock-event (class)
• knock-on-chan-event (class)
• language (method)
• language-code (method)
• language-event (class)
• link (method)
• link-uptime-in-seconds (method)
• linkname (method)
• links-end-event (class)
• links-event (class)
• list-end-event (class)
• list-event (class)
• list-start-event (class)
• local-users-event (class)
• logfile (method)
• luser-channels-event (class)
• luser-client-event (class)
• luser-me-event (class)
• luser-op-event (class)
• luser-staff-event (class)
• luser-unknown-event (class)
• maintainer (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• max-hops (method)
• max-langs (method)
• max-sendq (method)
• maxdepth (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• mode (method)
• mode (method)
• mode (method)
• mode-change-warn-event (class)
• mode-char (method)
• mode-char (method)
• mode-char (method)
• mode-char (method)
• mode-event (class)
• mode-params (method)
• mode-unknown-flag-event (class)
• modechar (method)
• modes (method)
• modes (method)
• modes (method)
• modes (method)
• modlist-end-event (class)
• modlist-event (class)
• motd-end-event (class)
• motd-event (class)
• motd-start-event (class)
• myinfo-event (class)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name-type (method)
• names-end-event (class)
• namreply-event (class)
• nanoseconds (method)
• need-more-params-event (class)
• networks-event (class)
• new-chan (method)
• new-nick (method)
• newtype (method)
• next-server (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick-collision-event (class)
• nick-event (class)
• nickinfo (method)
• nickname (method)
• nickname (method)
• nickname (method)
• nickname (method)
• nickname-in-use-event (class)
• no-admininfo-event (class)
• no-channel-modes-event (class)
• no-language-event (class)
• no-login-event (class)
• no-motd-event (class)
• no-nickname-given-event (class)
• no-operhost-event (class)
• no-origin-event (class)
• no-perm-for-host-event (class)
• no-privileges-event (class)
• no-privs-event (class)
• no-recipient-event (class)
• no-such-service-event (class)
• no-testline-event (class)
• no-text-to-send-event (class)
• no-top-level-event (class)
• no-topic-event (class)
• nosuch-channel-event (class)
• nosuch-nick-event (class)
• nosuch-server-event (class)
• not-implemented-event (class)
• not-on-channel-event (class)
• not-registered-event (class)
• notice-event (class)
• nousers-event (class)
• now-away-event (class)
• old-chan (method)
• omotd-end-event (class)
• omotd-event (class)
• omotd-start-event (class)
• oper (method)
• other-umode-event (class)
• parameter (method)
• parameter (method)
• parameters (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• part-event (class)
• password-mismatch-event (class)
• pfx-unroutable-event (class)
• ping-event (class)
• ping-freq (method)
• pong-event (class)
• port (method)
• port (method)
• port (method)
• port (method)
• privileges (method)
• privmsg-event (class)
• query (method)
• quit-event (class)
• rcvd-bytes (method)
• real-name (method)
• real-name (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• recvd-msgs (method)
• rehashing-event (class)
• remote-count (method)
• remote-pfx-event (class)
• resource (method)
• restricted-event (class)
• revision (method)
• save-nick-event (class)
• seconds (method)
• seconds (method)
• sender (method)
• sendq (method)
• sent-bytes (method)
• sent-msgs (method)
• serv (method)
• server-info (method)
• server-info (method)
• server-mode-lock-event (class)
• server-modes (method)
• server-modes-with-params (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-type (method)
• server-type (method)
• server1 (method)
• server1 (method)
• server2 (method)
• server2 (method)
• service (method)
• service-name (method)
• service-type (method)
• servlist-end-event (class)
• servlist-event (class)
• servmode-event (class)
• spam-event (class)
• staff-online-count (method)
• stats-cline-event (class)
• stats-commands-event (class)
• stats-end-event (class)
• stats-hline-event (class)
• stats-iline-event (class)
• stats-kline-event (class)
• stats-linkinfo-event (class)
• stats-nline-event (class)
• stats-oline-event (class)
• stats-uptime-event (class)
• stats-yline-event (class)
• statsl-line-event (class)
• summon-disabled-event (class)
• summoning-event (class)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target-address (method)
• target-fqdn (method)
• target-notify-event (class)
• target-trace (method)
• target-trace (method)
• target-umodeg-event (class)
• targets (method)
• testline-event (class)
• testmark-event (class)
• text-too-short-event (class)
• through-name (method)
• time-event (class)
• time-left (method)
• time-on-server-event (class)
• time-open (method)
• time-string (method)
• timezone (method)
• too-many-channels-event (class)
• too-many-knock-event (class)
• too-many-languages-event (class)
• too-many-matches-event (class)
• too-many-targets-event (class)
• topic (method)
• topic (method)
• topic (method)
• topic-event (class)
• topic-set-event (class)
• topic-who-time-event (class)
• trace-class-event (class)
• trace-connecting-event (class)
• trace-end-event (class)
• trace-handshake-event (class)
• trace-link-event (class)
• trace-log-event (class)
• trace-newtype-event (class)
• trace-operator-event (class)
• trace-server-event (class)
• trace-service-event (class)
• trace-unknown-event (class)
• trace-user-event (class)
• traceroute-hop-event (class)
• traceroute-start-event (class)
• try-again-event (class)
• umode-event (class)
• umodeg-msg-event (class)
• un-away-event (class)
• unavail-resource-event (class)
• uniqop-event (class)
• unique-privs-needed-event (class)
• unknow-nerror-event (class)
• unknown-command-event (class)
• unknown-mode-event (class)
• unknown-modes-event (class)
• unknown-server-mode-event (class)
• upstream-sendq (method)
• usec-ping (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user-mode-params (method)
• user-modes (method)
• user-modes (method)
• user-modes-with-params (method)
• user-not-in-channel-event (class)
• user-on-channel-event (class)
• userhost-event (class)
• username (method)
• users-disabled-event (class)
• users-dont-match-event (class)
• users-end-event (class)
• users-event (class)
• users-start-event (class)
• version (method)
• version (method)
• version (method)
• version (method)
• version-event (class)
• visible (method)
• vprotocol-version (method)
• vprotocol-version (method)
• vworld-warn-event (class)
• was-no-such-nick-event (class)
• welcome-event (class)
• who-end-event (class)
• who-reply-event (class)
• who-type (method)
• who-type (method)
• whois-account-event (class)
• whois-channels-event (class)
• whois-end-event (class)
• whois-idle-event (class)
• whois-language-event (class)
• whois-operator-event (class)
• whois-secure-event (class)
• whois-server-event (class)
• whois-staff-event (class)
• whois-user-event (class)
• whowas-details-event (class)
• whowas-end-event (class)
• whowas-user-event (class)
• wild-top-level-event (class)
• your-host-event (class)
• your-id-event (class)
• your-language-event (class)
• youre-banned-creep-event (class)
• youre-oper-event (class)
• youre-service-event (class)

Internal Definitions

• &string (method)
• &string (method)

4.1.18 colleen/asdf-extra.lisp

Dependency

irc-events.lisp (file)

Parent

colleen (system)

Location

asdf-extra.lisp

Exported Definitions

• define-module-system (macro)
• load-module (function)
• module-system (class)

4.1.19 colleen/launcher.lisp

Dependency

asdf-extra.lisp (file)

Parent

colleen (system)

Location

launcher.lisp

Exported Definitions

• shutdown (function)
• startup (function)

4.1.20 colleen/modules/system-definitions.lisp

Parent

modules (module)

Location

modules/system-definitions.lisp

4.1.21 colleen/modules/core.lisp

Parent

modules (module)

Location

modules/core.lisp

Exported Definitions

• active (method)
• start (method)
• stop (method)
• storage (method)
• (setf storage) (method)
• threads (method)
• (setf threads) (method)
• users (function)
• (setf users) (function)

Internal Definitions

• *channel-user-list* (special variable)
• core (class)
• refresh-channel-user-lists (function)

5 Packages

Packages are listed by definition order.

5.1 irc

Source

package.lisp (file)

Nickname

org.shirakumo.colleen.commands

Use List

common-lisp

Exported Definitions

• admin (function)
• away (function)
• broadcast (function)
• channel-mode (function)
• connect (function)
• error (function)
• info (function)
• invite (function)
• ison (function)
• join (function)
• kick (function)
• kill (function)
• links (function)
• list (function)
• names (function)
• nick (function)
• notice (function)
• oper (function)
• part (function)
• pass (function)
• ping (function)
• pong (function)
• privmsg (function)
• quit (function)
• rehash (function)
• restart (function)
• send-raw (function)
• server (function)
• squit (function)
• stats (function)
• summon (function)
• time (function)
• topic (function)
• trace (function)
• user (function)
• user-mode (function)
• userhost (function)
• users (function)
• version (function)
• wallops (function)
• who (function)
• whois (function)
• whowas (function)

Internal Definitions

raw (function)

5.2 colleen

Source

package.lisp (file)

Nickname

org.shirakumo.colleen

Use List

• bordeaux-threads
• common-lisp

Used By List

events

Exported Definitions

• *bot-modules* (special variable)
• *cmd-map* (special variable)
• *cmd-priority-array* (special variable)
• *config* (special variable)
• *config-directory* (special variable)
• *config-file* (special variable)
• *current-module* (special variable)
• *current-server* (special variable)
• *debugger* (special variable)
• *default-config-file* (special variable)
• *event-map* (special variable)
• *evt-map* (special variable)
• *evt-priority-map* (special variable)
• *irc-message-limit* (special variable)
• *priority-names* (special variable)
• *priority-nums* (special variable)
• *privmsg-line-limit* (special variable)
• *reply-code-map* (special variable)
• *server-encoding* (special variable)
• *servers* (special variable)
• *timer-map* (special variable)
• active (generic function)
• active (method)
• active (method)
• active (method)
• active (method)
• (setf active) (method)
• (setf active) (generic function)
• add-to-auth (function)
• apropos-command-handler (generic function)
• apropos-command-handler (method)
• apropos-command-handler (method)
• apropos-command-handler (method)
• apropos-command-handler (method)
• apropos-event-handler (generic function)
• apropos-event-handler (method)
• apropos-event-handler (method)
• apropos-time-handler (generic function)
• apropos-time-handler (method)
• apropos-time-handler (method)
• argslist (generic function)
• argslist (method)
• arguments (generic function)
• arguments (method)
• (setf arguments) (method)
• arguments (method)
• (setf arguments) (method)
• arguments (method)
• (setf arguments) (generic function)
• auth-p (function)
• auth-users (generic function)
• auth-users (method)
• (setf auth-users) (method)
• (setf auth-users) (generic function)
• bot-config (function)
• (setf bot-config) (function)
• break-string (function)
• cancelled (generic function)
• cancelled (method)
• (setf cancelled) (method)
• (setf cancelled) (generic function)
• channel (generic function)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• channel (method)
• (setf channel) (method)
• channel (method)
• (setf channel) (generic function)
• channel-event (class)
• channels (generic function)
• channels (method)
• channels (method)
• (setf channels) (method)
• (setf channels) (generic function)
• color-entities (function)
• command (generic function)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command (method)
• command-event (class)
• command-handler (function)
• (setf command-handler) (generic function)
• (setf command-handler) (method)
• (setf command-handler) (generic function)
• (setf command-handler) (method)
• command-handler (class)
• command-p (function)
• connect (generic function)
• connect (method)
• connect (method)
• connect (method)
• connection-failed (condition)
• define-command (macro)
• define-event (macro)
• define-group (macro)
• define-handler (macro)
• define-module (macro)
• define-module-system (macro)
• define-timer (macro)
• disconnect (generic function)
• disconnect (method)
• disconnect (method)
• disconnect (method)
• disconnect (condition)
• dispatch (generic function)
• dispatch (method)
• dispatch-command (generic function)
• dispatch-command (method)
• dispatched (generic function)
• dispatched (method)
• (setf dispatched) (method)
• (setf dispatched) (generic function)
• do-matching-command-handlers (macro)
• docstring (generic function)
• docstring (method)
• (setf docstring) (method)
• docstring (method)
• (setf docstring) (method)
• docstring (method)
• (setf docstring) (method)
• (setf docstring) (generic function)
• ensure-server (function)
• event (generic function)
• event (method)
• event (class)
• event-handler (function)
• (setf event-handler) (generic function)
• (setf event-handler) (method)
• (setf event-handler) (generic function)
• (setf event-handler) (method)
• event-handler (class)
• event-type (generic function)
• event-type (method)
• (setf event-type) (method)
• (setf event-type) (generic function)
• expected (generic function)
• expected (method)
• failed-server (generic function)
• failed-server (method)
• format-message (function)
• fstd-message (function)
• generate-handler-priority-cache (function)
• generated-command-event (class)
• get-current-module (function)
• get-current-module-name (function)
• get-module (function)
• get-server (function)
• group (generic function)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group (method)
• group-handler (class)
• handler-function (generic function)
• handler-function (method)
• (setf handler-function) (method)
• handler-function (method)
• (setf handler-function) (method)
• handler-function (method)
• (setf handler-function) (method)
• (setf handler-function) (generic function)
• handler-lock (generic function)
• handler-lock (method)
• (setf handler-lock) (method)
• (setf handler-lock) (generic function)
• host (generic function)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• host (method)
• (setf host) (method)
• (setf host) (generic function)
• hostmask (generic function)
• hostmask (method)
• hostmask (method)
• hostmask (method)
• hostmask (method)
• identifier (generic function)
• identifier (method)
• (setf identifier) (method)
• identifier (method)
• (setf identifier) (method)
• identifier (method)
• (setf identifier) (method)
• (setf identifier) (generic function)
• implicit-group-definition (condition)
• initial-error (generic function)
• initial-error (method)
• invalid-arguments (condition)
• launcher-function (generic function)
• launcher-function (method)
• (setf launcher-function) (method)
• (setf launcher-function) (generic function)
• load-config (function)
• load-module (function)
• load-storage (generic function)
• load-storage (method)
• make-event (function)
• message (generic function)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• message (method)
• (setf message) (generic function)
• (setf message) (method)
• (setf message) (method)
• message-too-long (condition)
• mirc-color->name (function)
• module (function)
• (setf module) (generic function)
• (setf module) (method)
• (setf module) (generic function)
• (setf module) (method)
• module (class)
• module-config-path (function)
• module-error (condition)
• module-launcher (function)
• module-stop (condition)
• module-system (class)
• module-system-not-found (condition)
• module-thread (function)
• (setf module-thread) (generic function)
• (setf module-thread) (method)
• (setf module-thread) (generic function)
• (setf module-thread) (method)
• name (generic function)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• name (method)
• (setf name) (generic function)
• (setf name) (method)
• network-error (condition)
• nick (generic function)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• nick (method)
• (setf nick) (method)
• nick (method)
• (setf nick) (method)
• nick (method)
• (setf nick) (generic function)
• not-authorized (condition)
• output-stream (generic function)
• output-stream (method)
• (setf output-stream) (method)
• (setf output-stream) (generic function)
• parse-delay (generic function)
• parse-delay (method)
• parse-delay (method)
• password (generic function)
• password (method)
• (setf password) (method)
• (setf password) (generic function)
• pattern (generic function)
• pattern (method)
• (setf pattern) (method)
• (setf pattern) (generic function)
• ping-timeout (condition)
• port (generic function)
• port (method)
• port (method)
• port (method)
• port (method)
• port (method)
• (setf port) (method)
• (setf port) (generic function)
• prefix (generic function)
• prefix (method)
• print-module-thread-stats (function)
• priority (generic function)
• priority (method)
• (setf priority) (method)
• priority (method)
• (setf priority) (method)
• (setf priority) (generic function)
• priority-name (function)
• (setf priority-name) (generic function)
• (setf priority-name) (method)
• (setf priority-name) (generic function)
• (setf priority-name) (method)
• priority-num (function)
• (setf priority-num) (generic function)
• (setf priority-num) (method)
• (setf priority-num) (generic function)
• (setf priority-num) (method)
• realname (generic function)
• realname (method)
• (setf realname) (method)
• (setf realname) (generic function)
• reconnect (generic function)
• reconnect (method)
• reconnect (method)
• relay-command (function)
• remove-command-handler (function)
• remove-event-handler (function)
• remove-from-auth (function)
• remove-module-thread (function)
• remove-time-handler (function)
• reply->keyword (generic function)
• reply->keyword (method)
• reply->keyword (method)
• reschedule-timer (function)
• respond (generic function)
• respond (method)
• respond (method)
• respond (method)
• save-config (function)
• save-storage (generic function)
• save-storage (method)
• scanner (generic function)
• scanner (method)
• (setf scanner) (method)
• (setf scanner) (generic function)
• schedule-timer (function)
• schedulings (generic function)
• schedulings (method)
• (setf schedulings) (method)
• (setf schedulings) (generic function)
• send-event (class)
• server (generic function)
• server (method)
• server (method)
• server (class)
• server-config (function)
• set-command-function (function)
• set-handler-function (function)
• set-timer-function (function)
• shutdown (function)
• simple-launcher (function)
• simulate-command (function)
• standard-message (function)
• start (generic function)
• start (method)
• start (method)
• start (method)
• start-module (function)
• startup (function)
• stop (generic function)
• stop (method)
• stop (method)
• stop (method)
• stop-module (function)
• stop-module-thread (function)
• stop-time-handler (function)
• storage (generic function)
• storage (method)
• (setf storage) (method)
• storage (method)
• (setf storage) (method)
• (setf storage) (generic function)
• strip-colors (function)
• subcommands (generic function)
• subcommands (method)
• (setf subcommands) (method)
• (setf subcommands) (generic function)
• sweep-all-module-threads (function)
• sweep-module-threads (function)
• threads (generic function)
• threads (method)
• (setf threads) (method)
• threads (method)
• threads (method)
• threads (method)
• (setf threads) (method)
• (setf threads) (generic function)
• time-handler (function)
• (setf time-handler) (generic function)
• (setf time-handler) (method)
• (setf time-handler) (generic function)
• (setf time-handler) (method)
• time-handler (class)
• timer-type (generic function)
• timer-type (method)
• (setf timer-type) (method)
• (setf timer-type) (generic function)
• to-module-name (generic function)
• to-module-name (method)
• to-module-name (method)
• to-module-name (method)
• user-event (class)
• username (generic function)
• username (method)
• username (method)
• (setf username) (method)
• username (method)
• (setf username) (generic function)
• users (function)
• (setf users) (function)
• with-module (macro)
• with-module-lock (macro)
• with-module-storage (macro)
• with-module-thread (macro)

Internal Definitions

• *channel-user-list* (special variable)
• *formatting-regex* (special variable)
• *irc-message-regex* (special variable)
• *mirc-color-map* (special variable)
• *mirc-color-regex* (special variable)
• *sample-config-file* (special variable)
• *unix-epoch-difference* (special variable)
• *user-regex* (special variable)
• arguments-bind (macro)
• arguments-match-p (function)
• build-lambda-call (function)
• call-with-reconnect-handler (function)
• cancel (function)
• core (class)
• ensure-list (function)
• escape-regex-symbols (function)
• extract-lambda-vars (function)
• flatten-lambda-list (function)
• force-release-lock (function)
• generalize-module-accessor (macro)
• generate-command-priority-cache (function)
• group-command-handler (function)
• handle (function)
• handled (generic function)
• handled (method)
• (setf handled) (method)
• (setf handled) (generic function)
• lambda-keyword-p (function)
• lambda-list->string (function)
• last-ping (generic function)
• last-ping (method)
• (setf last-ping) (method)
• (setf last-ping) (generic function)
• launch-timer (function)
• limit-form (generic function)
• limit-form (method)
• make-server-thread (function)
• no-command-matched (function)
• package-symbol (function)
• ping-loop (function)
• ping-thread (generic function)
• ping-thread (method)
• (setf ping-thread) (method)
• (setf ping-thread) (generic function)
• read-command (function)
• read-loop (function)
• read-thread (generic function)
• read-thread (method)
• (setf read-thread) (method)
• (setf read-thread) (generic function)
• receive-raw-message (function)
• refresh-channel-user-lists (function)
• required-lambda-vars (function)
• restart-thread (generic function)
• restart-thread (method)
• (setf restart-thread) (method)
• (setf restart-thread) (generic function)
• socket (generic function)
• socket (method)
• (setf socket) (method)
• (setf socket) (generic function)
• socket-stream (generic function)
• socket-stream (method)
• (setf socket-stream) (method)
• (setf socket-stream) (generic function)
• timer-timeout (function)
• with-reconnect-handler (macro)
• with-repeating-restart (macro)
• xor (macro)

5.3 events

Source

package.lisp (file)

Nickname

org.shirakumo.colleen.events

Use List

• colleen
• common-lisp

Exported Definitions

• active-type (generic function)
• active-type (method)
• address (generic function)
• address (method)
• admin-email-event (class)
• admin-loc1-event (class)
• admin-loc2-event (class)
• admin-location (generic function)
• admin-location (method)
• admin-location (method)
• admin-me-event (class)
• already-registered-event (class)
• authname (generic function)
• authname (method)
• away-event (class)
• backstream-sendq (generic function)
• backstream-sendq (method)
• bad-channel-key-event (class)
• bad-channel-mask-event (class)
• bad-char-encoding-event (class)
• bad-mask-event (class)
• banid (generic function)
• banid (method)
• banlist-end-event (class)
• banlist-event (class)
• banlist-full-event (class)
• banned-from-chan-event (class)
• bounce-event (class)
• byte-count (generic function)
• byte-count (method)
• cannot-change-chanmode-event (class)
• cannot-change-servermode-event (class)
• cannot-change-umode-event (class)
• cannot-send-to-chan-event (class)
• cannot-send-to-nick-event (class)
• cannot-set-modes-event (class)
• cant-kill-server-event (class)
• chan-char (generic function)
• chan-char (method)
• chan-modes (generic function)
• chan-modes (method)
• chan-open-event (class)
• chan-privs-needed-event (class)
• channel-full-event (class)
• channel-mode-event (class)
• channel-modes-with-params (generic function)
• channel-modes-with-params (method)
• chanredir-event (class)
• charset (generic function)
• charset (method)
• class-count (generic function)
• class-count (method)
• client-name (generic function)
• client-name (method)
• cmd-count (generic function)
• cmd-count (method)
• code (generic function)
• code (method)
• code (method)
• codes (generic function)
• codes (method)
• comments (generic function)
• comments (method)
• config-file (generic function)
• config-file (method)
• connect-freq (generic function)
• connect-freq (method)
• connection-address (generic function)
• connection-address (method)
• created-event (class)
• debug-level (generic function)
• debug-level (method)
• destination (generic function)
• destination (method)
• disabled-event (class)
• email-address (generic function)
• email-address (method)
• erroneusnickname-event (class)
• etrace-event (class)
• etrace-full-event (class)
• exceptionmask (generic function)
• exceptionmask (method)
• exceptlist-end-event (class)
• exceptlist-event (class)
• file (generic function)
• file (method)
• file-error-event (class)
• flags (generic function)
• flags (method)
• flags (method)
• generic-end-event (class)
• global-users-event (class)
• help-end-event (class)
• help-start-event (class)
• help-txt-event (class)
• hop (generic function)
• hop (method)
• hopcount (generic function)
• hopcount (method)
• hopcount (method)
• hops (generic function)
• hops (method)
• host-hidden-event (class)
• host2 (generic function)
• host2 (method)
• hostname (generic function)
• hostname (method)
• hostname (method)
• info-end-event (class)
• info-event (class)
• int (generic function)
• int (method)
• int (method)
• int (method)
• intc (generic function)
• intc (method)
• ints (generic function)
• ints (method)
• invited-event (class)
• invitee (generic function)
• invitee (method)
• invitelist-end-event (class)
• invitelist-event (class)
• invitemask (generic function)
• invitemask (method)
• inviteonly-chan-event (class)
• inviting-event (class)
• ison-event (class)
• isupport-event (class)
• join-event (class)
• key-set-event (class)
• kick-event (class)
• knock-disabled-event (class)
• knock-dlvr-event (class)
• knock-event (class)
• knock-on-chan-event (class)
• language (generic function)
• language (method)
• language-code (generic function)
• language-code (method)
• language-event (class)
• link (generic function)
• link (method)
• link-uptime-in-seconds (generic function)
• link-uptime-in-seconds (method)
• linkname (generic function)
• linkname (method)
• links-end-event (class)
• links-event (class)
• list-end-event (class)
• list-event (class)
• list-start-event (class)
• local-users-event (class)
• logfile (generic function)
• logfile (method)
• luser-channels-event (class)
• luser-client-event (class)
• luser-me-event (class)
• luser-op-event (class)
• luser-staff-event (class)
• luser-unknown-event (class)
• maintainer (generic function)
• maintainer (method)
• mask (generic function)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• mask (method)
• max-hops (generic function)
• max-hops (method)
• max-langs (generic function)
• max-langs (method)
• max-sendq (generic function)
• max-sendq (method)
• maxdepth (generic function)
• maxdepth (method)
• mode (generic function)
• mode (method)
• mode (method)
• mode (method)
• mode-change-warn-event (class)
• mode-char (generic function)
• mode-char (method)
• mode-char (method)
• mode-char (method)
• mode-char (method)
• mode-event (class)
• mode-params (generic function)
• mode-params (method)
• mode-unknown-flag-event (class)
• modechar (generic function)
• modechar (method)
• modes (generic function)
• modes (method)
• modes (method)
• modes (method)
• modes (method)
• modlist-end-event (class)
• modlist-event (class)
• motd-end-event (class)
• motd-event (class)
• motd-start-event (class)
• myinfo-event (class)
• name-type (generic function)
• name-type (method)
• names-end-event (class)
• namreply-event (class)
• nanoseconds (generic function)
• nanoseconds (method)
• need-more-params-event (class)
• networks-event (class)
• new-chan (generic function)
• new-chan (method)
• new-nick (generic function)
• new-nick (method)
• newtype (generic function)
• newtype (method)
• next-server (generic function)
• next-server (method)
• nick-collision-event (class)
• nick-event (class)
• nickinfo (generic function)
• nickinfo (method)
• nickname (generic function)
• nickname (method)
• nickname (method)
• nickname (method)
• nickname (method)
• nickname-in-use-event (class)
• no-admininfo-event (class)
• no-channel-modes-event (class)
• no-language-event (class)
• no-login-event (class)
• no-motd-event (class)
• no-nickname-given-event (class)
• no-operhost-event (class)
• no-origin-event (class)
• no-perm-for-host-event (class)
• no-privileges-event (class)
• no-privs-event (class)
• no-recipient-event (class)
• no-such-service-event (class)
• no-testline-event (class)
• no-text-to-send-event (class)
• no-top-level-event (class)
• no-topic-event (class)
• nosuch-channel-event (class)
• nosuch-nick-event (class)
• nosuch-server-event (class)
• not-implemented-event (class)
• not-on-channel-event (class)
• not-registered-event (class)
• notice-event (class)
• nousers-event (class)
• now-away-event (class)
• old-chan (generic function)
• old-chan (method)
• omotd-end-event (class)
• omotd-event (class)
• omotd-start-event (class)
• oper (generic function)
• oper (method)
• other-umode-event (class)
• parameter (generic function)
• parameter (method)
• parameter (method)
• parameters (generic function)
• parameters (method)
• params (generic function)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• params (method)
• part-event (class)
• password-mismatch-event (class)
• pfx-unroutable-event (class)
• ping-event (class)
• ping-freq (generic function)
• ping-freq (method)
• pong-event (class)
• privileges (generic function)
• privileges (method)
• privmsg-event (class)
• query (generic function)
• query (method)
• quit-event (class)
• rcvd-bytes (generic function)
• rcvd-bytes (method)
• real-name (generic function)
• real-name (method)
• real-name (method)
• reason (generic function)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• reason (method)
• recvd-msgs (generic function)
• recvd-msgs (method)
• rehashing-event (class)
• remote-count (generic function)
• remote-count (method)
• remote-pfx-event (class)
• resource (generic function)
• resource (method)
• restricted-event (class)
• revision (generic function)
• revision (method)
• save-nick-event (class)
• seconds (generic function)
• seconds (method)
• seconds (method)
• sender (generic function)
• sender (method)
• sendq (generic function)
• sendq (method)
• sent-bytes (generic function)
• sent-bytes (method)
• sent-msgs (generic function)
• sent-msgs (method)
• serv (generic function)
• serv (method)
• server-info (generic function)
• server-info (method)
• server-info (method)
• server-mode-lock-event (class)
• server-modes (generic function)
• server-modes (method)
• server-modes-with-params (generic function)
• server-modes-with-params (method)
• server-name (generic function)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-name (method)
• server-type (generic function)
• server-type (method)
• server-type (method)
• server1 (generic function)
• server1 (method)
• server1 (method)
• server2 (generic function)
• server2 (method)
• server2 (method)
• service (generic function)
• service (method)
• service-name (generic function)
• service-name (method)
• service-type (generic function)
• service-type (method)
• servlist-end-event (class)
• servlist-event (class)
• servmode-event (class)
• spam-event (class)
• staff-online-count (generic function)
• staff-online-count (method)
• stats-cline-event (class)
• stats-commands-event (class)
• stats-end-event (class)
• stats-hline-event (class)
• stats-iline-event (class)
• stats-kline-event (class)
• stats-linkinfo-event (class)
• stats-nline-event (class)
• stats-oline-event (class)
• stats-uptime-event (class)
• stats-yline-event (class)
• statsl-line-event (class)
• summon-disabled-event (class)
• summoning-event (class)
• target (generic function)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target (method)
• target-address (generic function)
• target-address (method)
• target-fqdn (generic function)
• target-fqdn (method)
• target-notify-event (class)
• target-trace (generic function)
• target-trace (method)
• target-trace (method)
• target-umodeg-event (class)
• targets (generic function)
• targets (method)
• testline-event (class)
• testmark-event (class)
• text-too-short-event (class)
• through-name (generic function)
• through-name (method)
• time-event (class)
• time-left (generic function)
• time-left (method)
• time-on-server-event (class)
• time-open (generic function)
• time-open (method)
• time-string (generic function)
• time-string (method)
• timezone (generic function)
• timezone (method)
• too-many-channels-event (class)
• too-many-knock-event (class)
• too-many-languages-event (class)
• too-many-matches-event (class)
• too-many-targets-event (class)
• topic (generic function)
• topic (method)
• topic (method)
• topic (method)
• topic-event (class)
• topic-set-event (class)
• topic-who-time-event (class)
• trace-class-event (class)
• trace-connecting-event (class)
• trace-end-event (class)
• trace-handshake-event (class)
• trace-link-event (class)
• trace-log-event (class)
• trace-newtype-event (class)
• trace-operator-event (class)
• trace-server-event (class)
• trace-service-event (class)
• trace-unknown-event (class)
• trace-user-event (class)
• traceroute-hop-event (class)
• traceroute-start-event (class)
• try-again-event (class)
• umode-event (class)
• umodeg-msg-event (class)
• un-away-event (class)
• unavail-resource-event (class)
• uniqop-event (class)
• unique-privs-needed-event (class)
• unknow-nerror-event (class)
• unknown-command-event (class)
• unknown-mode-event (class)
• unknown-modes-event (class)
• unknown-server-mode-event (class)
• upstream-sendq (generic function)
• upstream-sendq (method)
• usec-ping (generic function)
• usec-ping (method)
• user (generic function)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user (method)
• user-mode-params (generic function)
• user-mode-params (method)
• user-modes (generic function)
• user-modes (method)
• user-modes (method)
• user-modes-with-params (generic function)
• user-modes-with-params (method)
• user-not-in-channel-event (class)
• user-on-channel-event (class)
• userhost-event (class)
• users-disabled-event (class)
• users-dont-match-event (class)
• users-end-event (class)
• users-event (class)
• users-start-event (class)
• version (generic function)
• version (method)
• version (method)
• version (method)
• version (method)
• version-event (class)
• visible (generic function)
• visible (method)
• vprotocol-version (generic function)
• vprotocol-version (method)
• vprotocol-version (method)
• vworld-warn-event (class)
• was-no-such-nick-event (class)
• welcome-event (class)
• who-end-event (class)
• who-reply-event (class)
• who-type (generic function)
• who-type (method)
• who-type (method)
• whois-account-event (class)
• whois-channels-event (class)
• whois-end-event (class)
• whois-idle-event (class)
• whois-language-event (class)
• whois-operator-event (class)
• whois-secure-event (class)
• whois-server-event (class)
• whois-staff-event (class)
• whois-user-event (class)
• whowas-details-event (class)
• whowas-end-event (class)
• whowas-user-event (class)
• wild-top-level-event (class)
• your-host-event (class)
• your-id-event (class)
• your-language-event (class)
• youre-banned-creep-event (class)
• youre-oper-event (class)
• youre-service-event (class)

Internal Definitions

• &string (generic function)
• &string (method)
• &string (method)