The cl-irc Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-irc Reference Manual

This is the cl-irc Reference Manual, version 0.9.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:11:16 2018 GMT+0.

• Introduction:  What cl-irc is all about
• Systems:  The systems documentation
• Files:  The files documentation
• Packages:  The packages documentation
• Definitions:  The symbols documentation
• Indexes:  Concepts, functions, variables and data types

Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-irc: A Common Lisp interface to the client-part of the IRC
protocol; RFCs 2810, 2811 and 2812.  See doc/user-guide.txt for more
information.

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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

• The cl-irc system:  

Previous: , Up: Systems   [Contents][Index]

2.1 cl-irc

Author

Erik Enge & Contributors

License

MIT

Description

Common Lisp interface to the IRC protocol

Version

0.9.2

Dependencies
Source

cl-irc.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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

• Lisp files:  

Previous: , Up: Files   [Contents][Index]

3.1 Lisp

• The cl-irc.asd file:  
• The cl-irc/package.lisp file:  
• The cl-irc/variable.lisp file:  
• The cl-irc/utility.lisp file:  
• The cl-irc/parse-message.lisp file:  
• The cl-irc/protocol.lisp file:  
• The cl-irc/command.lisp file:  
• The cl-irc/event.lisp file:  

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-irc.asd

Location

cl-irc.asd

Systems

cl-irc (system)

Packages

cl-irc-system

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-irc/package.lisp

Parent

cl-irc (system)

Location

package.lisp

Packages

cl-irc

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-irc/variable.lisp

Dependency

package.lisp (file)

Parent

cl-irc (system)

Location

variable.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-irc/utility.lisp

Dependency

variable.lisp (file)

Parent

cl-irc (system)

Location

utility.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-irc/parse-message.lisp

Dependency

utility.lisp (file)

Parent

cl-irc (system)

Location

parse-message.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 cl-irc/protocol.lisp

Dependency

parse-message.lisp (file)

Parent

cl-irc (system)

Location

protocol.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 cl-irc/command.lisp

Dependency

protocol.lisp (file)

Parent

cl-irc (system)

Location

command.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.8 cl-irc/event.lisp

Dependency

command.lisp (file)

Parent

cl-irc (system)

Location

event.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.

• The cl-irc-system package:  
• The cl-irc package:  

Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-irc-system

Source

cl-irc.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 cl-irc

Source

package.lisp (file)

Nickname

irc

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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

• Exported definitions:  
• Internal definitions:  

Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions

• Exported macros:  
• Exported functions:  
• Exported generic functions:  
• Exported conditions:  
• Exported classes:  

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: destructuring-arguments LAMBDA-LIST MESSAGE &body BODY

Destructures the ‘arguments’ slot in ‘message’ according
to ‘lambda-list’ and binds them in ‘body’.

The lambda list syntax is as follows:

wholevar::= &whole var
reqvars::= var*
optvars::= [&optional {var | (var [init-form [supplied-p-parameter]])}* ] restvar::= [&rest var]
reqtrailingvars::= [&req var*]
lambda-list::= (wholevar reqvars optvars restvar reqtrailingvars)

With the exception of &req (which is new) and &rest, all lambda list keywords are analogous to a destructuring lambda list (see clhs 3.4.5).

If &req is specified, these values are consumed off the end of the list before processing any preceeding &optional or &rest keywords.

For any variable, the ‘:ignored’ keyword can be passed instead, indicating the binding should be ignored in the ‘body’.

Package

cl-irc

Source

utility.lisp (file)

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: apply-mode-changes CONNECTION TARGET MODE-ARGUMENTS SERVER-P
Package

cl-irc

Source

utility.lisp (file)

Function: connect &key NICKNAME USERNAME REALNAME PASSWORD MODE SERVER PORT CONNECTION-TYPE CONNECTION-SECURITY LOGGING-STREAM

Connect to server and return a connection object.

‘port’ and ‘connection-security’ have a relation: when ‘port’ equals ‘:default’ ‘*default-irc-server-port*’ is used to find which port to connect to. ‘connection-security’ determines which port number is found.

‘connection-security’ can be either ‘:none’ or ‘:ssl’. When passing ‘:ssl’, the cl+ssl library must have been loaded by the caller.

Package

cl-irc

Source

command.lisp (file)

Function: find-reply-name REPLY-NUMBER &key REPLY-NAMES

Numeric replies in the IRC RFCs have more meaningful names. Given a numeric reply (‘reply-number’) this function will either return the symbol representing the reply or raise a continuable error (‘no-such-reply’) which gives you the opportunity to ignore the situation.

Package

cl-irc

Source

parse-message.lisp (file)

Function: make-channel CONNECTION &key NAME TOPIC MODES USERS USER-COUNT
Package

cl-irc

Source

protocol.lisp (file)

Function: make-connection &key CONNECTION-TYPE USER PASSWORD SERVER-NAME SERVER-PORT NETWORK-STREAM OUTGOING-EXTERNAL-FORMAT CLIENT-STREAM HOOKS
Package

cl-irc

Source

protocol.lisp (file)

Function: make-dcc-chat-connection &key REMOTE-USER CLIENT-STREAM IRC-CONNECTION CLOSE-ON-MAIN NETWORK-STREAM OUTGOING-EXTERNAL-FORMAT HOOKS
Package

cl-irc

Source

protocol.lisp (file)

Function: make-user CONNECTION &key NICKNAME USERNAME HOSTNAME REALNAME
Package

cl-irc

Source

protocol.lisp (file)

Function: mask-matches-p MASK HOSTNAME

Wildcard matching.

Uses ‘*’ to match any number of characters and ‘?’ to match exactly any one character. The routine does not enforce hostmask matching patterns, but can be used for the purpose.

Package

cl-irc

Source

utility.lisp (file)

Function: normalize-channel-name CONNECTION STRING

Normalize ‘string’ so that it represents an all-downcased channel name.

Package

cl-irc

Source

protocol.lisp (file)

Function: normalize-nickname CONNECTION STRING

Normalize ‘string’ so that represents an all-downcased IRC nickname.

Package

cl-irc

Source

protocol.lisp (file)

Function: parse-mode-arguments CONNECTION TARGET ARGUMENTS &key SERVER-P

Create a list of mode changes with their arguments for ‘target’
from ‘mode-string’ and ‘arguments’.

Throw nil to the UNKNOWN-MODE symbol if any of the mode chars are unknown.

Package

cl-irc

Source

utility.lisp (file)

Function: parse-raw-message STRING &key START

Assuming ‘string’ is a valid IRC message, parse the message and return the values in the following order:

- source
- user
- host
- command
- arguments
- trailing-argument

Any values not present will be represented as nil.

Package

cl-irc

Source

parse-message.lisp (file)

Function: start-background-message-handler CONNECTION

Read messages from the ‘connection’, parse them and dispatch irc-message-event on them. Returns background process ID if available.

This function has been DEPRECATED. The function body is meant as an example for library users on handling connection input. Users
are strongly encouraged to implement error handling (which is lacking from the prototype given here.

Package

cl-irc

Source

protocol.lisp (file)

Function: stop-background-message-handler PROCESS

Stops a background message handler process returned by the start function.

Just as its cousin START-BACKGROUND-MESSAGE-HANDLER,
this function is DEPRECATED.

Package

cl-irc

Source

protocol.lisp (file)

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: add-channel CONNECTION CHANNEL
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: add-channel (CONNECTION connection) (CHANNEL channel)

Add ‘channel’ to ‘connection’.

Generic Function: add-default-hooks CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: add-default-hooks (CONNECTION connection)
Generic Function: add-hook CONNECTION CLASS HOOK
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: add-hook CONNECTION CLASS HOOK

Add ‘hook’ to ‘class’.

Generic Function: add-mode TARGET MODE-NAME MODE

Add the mode-holding object ‘mode-value’ to ‘target’ under the access key ‘mode-name’.

If mode-value is a subtype of irc-mode, it is added as-is. Otherwise, a mode-object will be generated from the

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: add-mode TARGET MODE-NAME MODE
Generic Function: add-user OBJECT USER
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: add-user (CHANNEL channel) (USER user)
Method: add-user (CONNECTION connection) (USER user)

Add ‘user’ to ‘connection’.

Generic Function: admin CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: admin (CONNECTION connection) &optional TARGET
Generic Function: append-hook CONNECTION CLASS HOOK
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: append-hook CONNECTION CLASS HOOK

Append ‘hook’ to ‘class’.

Generic Function: arguments OBJECT
Generic Function: (setf arguments) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: arguments (DCC-MESSAGE dcc-message)
Method: (setf arguments) NEW-VALUE (DCC-MESSAGE dcc-message)
Source

protocol.lisp (file)

Method: arguments (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf arguments) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: away CONNECTION MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: away (CONNECTION connection) (MESSAGE string)
Generic Function: ban CONNECTION CHANNEL MASK
Package

cl-irc

Source

command.lisp (file)

Methods
Method: ban (CONNECTION connection) (CHANNEL channel) (MASK string)
Method: ban (CONNECTION connection) (CHANNEL string) (MASK string)
Generic Function: change-nickname CONNECTION USER NEW-NICKNAME
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: change-nickname (CONNECTION connection) (USER user) NEW-NICKNAME
Generic Function: channels OBJECT
Generic Function: (setf channels) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: channels (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf channels) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Method: channels (CONNECTION connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf channels) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: client-log CONNECTION MESSAGE &optional PREFIX
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: client-log (CONNECTION connection) (MESSAGE ctcp-mixin) &optional PREFIX
Method: client-log (CONNECTION dcc-connection) (MESSAGE dcc-message) &optional PREFIX
Method: client-log (CONNECTION connection) (MESSAGE irc-message) &optional PREFIX
Generic Function: client-stream OBJECT
Generic Function: (setf client-stream) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: client-stream (DCC-CONNECTION dcc-connection)
Method: (setf client-stream) NEW-VALUE (DCC-CONNECTION dcc-connection)

Input from the remote is sent to this stream.

Source

protocol.lisp (file)

Method: client-stream (CONNECTION connection)
Method: (setf client-stream) NEW-VALUE (CONNECTION connection)

Messages coming back from the server are sent to this stream.

Source

protocol.lisp (file)

Generic Function: close-on-main OBJECT
Generic Function: (setf close-on-main) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: close-on-main (DCC-CONNECTION dcc-connection)
Method: (setf close-on-main) NEW-VALUE (DCC-CONNECTION dcc-connection)

Makes sure that the DCC connection is closed
as soon as either the IRC connection is actively closed or when a lost connection is detected.

Source

protocol.lisp (file)

Generic Function: command OBJECT
Generic Function: (setf command) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: command (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf command) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: connectedp CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: connectedp (CONNECTION dcc-connection)
Method: connectedp (CONNECTION connection)

Returns t if ‘connection’ is connected to a server and is ready for input.

Generic Function: connection OBJECT
Generic Function: (setf connection) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: connection (DCC-MESSAGE dcc-message)
Method: (setf connection) NEW-VALUE (DCC-MESSAGE dcc-message)
Source

protocol.lisp (file)

Method: connection (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf connection) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: ctcp-chat-initiate CONNECTION NICKNAME &key PASSIVE

Initiate a DCC chat session with ‘nickname’ associated
with ‘connection’.

If ‘passive’ is non-NIL, the remote is requested to serve as a DCC host. Otherwise, the local system will serve as a DCC host. The latter may be a problem for firewalled or NATted hosts.

Package

cl-irc

Source

command.lisp (file)

Methods
Method: ctcp-chat-initiate (CONNECTION dcc-chat-connection) NICKNAME &key PASSIVE
Method: ctcp-chat-initiate (CONNECTION connection) (NICKNAME string) &key PASSIVE
Generic Function: dcc-close CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: dcc-close (CONNECTION dcc-connection)
Generic Function: dcc-message-event CONNECTION MESSAGE

Upon receipt of an IRC message from the
connection’s stream, irc-message-event will be called with the message.

Package

cl-irc

Source

event.lisp (file)

Methods
Method: dcc-message-event CONNECTION (MESSAGE dcc-message)
Generic Function: dcc-request-accept MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: dcc-request-accept (MESSAGE dcc-ctcp-dcc-chat-request-message)
Method: dcc-request-accept (MESSAGE ctcp-dcc-chat-request-message)
Generic Function: dcc-request-cancel CONNECTION TOKEN
Package

cl-irc

Source

command.lisp (file)

Methods
Method: dcc-request-cancel (CONNECTION dcc-chat-connection) TOKEN
Method: dcc-request-cancel (CONNECTION connection) TOKEN
Generic Function: dcc-request-reject MESSAGE &optional REASON
Package

cl-irc

Source

command.lisp (file)

Methods
Method: dcc-request-reject (MESSAGE dcc-ctcp-dcc-chat-request-message) &optional REASON
Method: dcc-request-reject (MESSAGE ctcp-dcc-chat-request-message) &optional REASON
Generic Function: deop CONNECTION CHANNEL NICKNAME
Package

cl-irc

Source

command.lisp (file)

Methods
Method: deop (CONNECTION connection) (CHANNEL channel) (USER user)
Method: deop (CONNECTION connection) (CHANNEL string) (NICKNAME string)
Generic Function: devoice CONNECTION CHANNEL NICKNAME
Package

cl-irc

Source

command.lisp (file)

Methods
Method: devoice (CONNECTION connection) (CHANNEL channel) (USER user)
Method: devoice (CONNECTION connection) (CHANNEL string) (NICKNAME string)
Generic Function: die CONNECTION
Package

cl-irc

Source

command.lisp (file)

Methods
Method: die (CONNECTION connection)
Generic Function: error- CONNECTION MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: error- (CONNECTION connection) (MESSAGE string)
Generic Function: find-channel CONNECTION CHANNEL
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: find-channel (CONNECTION connection) (CHANNEL string)

Return channel as designated by ‘channel’. If no such channel can be found, return nil.

Generic Function: find-user CONNECTION NICKNAME
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: find-user (CONNECTION connection) (NICKNAME string)

Return user as designated by ‘nickname’ or nil if no such user is known.

Generic Function: get-hooks CONNECTION CLASS
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: get-hooks CONNECTION (CLASS symbol)

Return a list of all hooks for ‘class’.

Generic Function: get-mode TARGET MODE

Get the value associated with ‘mode’ for ‘target’ or ‘nil’ if no mode available.

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: get-mode TARGET MODE
Generic Function: has-mode-p TARGET MODE

Return a generalised boolean indicating if ‘target’ has a mode ‘mode’ associated with it.

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: has-mode-p TARGET MODE
Generic Function: has-mode-value-p TARGET MODE VALUE &key KEY TEST

Return a generalised boolean indicating if ‘target’ has
a mode ‘mode’ associated with the value ‘value’ for given a ‘key’ transform and ‘test’ test.

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: has-mode-value-p TARGET MODE VALUE &key KEY TEST
Generic Function: host OBJECT
Generic Function: (setf host) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: host (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf host) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: hostname OBJECT
Generic Function: (setf hostname) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: hostname (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf hostname) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: info CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: info (CONNECTION connection) &optional TARGET
Generic Function: invite CONNECTION USER CHANNEL
Package

cl-irc

Source

command.lisp (file)

Methods
Method: invite (CONNECTION connection) (USER user) (CHANNEL channel)
Method: invite (CONNECTION connection) (NICKNAME string) (CHANNEL string)
Generic Function: irc-connection OBJECT
Generic Function: (setf irc-connection) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: irc-connection (DCC-CONNECTION dcc-connection)
Method: (setf irc-connection) NEW-VALUE (DCC-CONNECTION dcc-connection)

The associated IRC connection used to send
CTCP control commands. When this connection is closed/lost, the DCC connection should be terminated too for security reasons.

Source

protocol.lisp (file)

Generic Function: irc-message-event CONNECTION MESSAGE

Upon receipt of an IRC message from the
connection’s stream, irc-message-event will be called with the message.

Package

cl-irc

Source

event.lisp (file)

Methods
Method: irc-message-event CONNECTION (MESSAGE ctcp-dcc-send-request-message)
Method: irc-message-event CONNECTION (MESSAGE ctcp-dcc-chat-request-message)
Method: irc-message-event CONNECTION (MESSAGE irc-message)
Generic Function: ison CONNECTION USER
Package

cl-irc

Source

command.lisp (file)

Methods
Method: ison (CONNECTION connection) (USER user)
Method: ison (CONNECTION connection) (NICKNAME string)
Generic Function: join CONNECTION CHANNEL &key PASSWORD
Package

cl-irc

Source

command.lisp (file)

Methods
Method: join (CONNECTION connection) (CHANNEL channel) &key PASSWORD
Method: join (CONNECTION connection) (CHANNEL string) &key PASSWORD
Generic Function: kick CONNECTION CHANNEL USER &optional COMMENT
Package

cl-irc

Source

command.lisp (file)

Methods
Method: kick (CONNECTION connection) (CHANNEL channel) (USER user) &optional COMMENT
Method: kick (CONNECTION connection) (CHANNEL string) (USER string) &optional COMMENT
Generic Function: kill CONNECTION USER &optional COMMENT
Package

cl-irc

Source

command.lisp (file)

Methods
Method: kill (CONNECTION connection) (USER user) &optional COMMENT
Method: kill (CONNECTION connection) (NICKNAME string) &optional COMMENT
Generic Function: links CONNECTION &optional REMOTE-SERVER SERVER-MASK
Package

cl-irc

Source

command.lisp (file)

Methods
Method: links (CONNECTION connection) &optional REMOTE-SERVER SERVER-MASK
Generic Function: list- CONNECTION &optional CHANNEL TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: list- (CONNECTION connection) &optional CHANNEL TARGET
Generic Function: lusers CONNECTION &optional MASK TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: lusers (CONNECTION connection) &optional MASK TARGET
Generic Function: mode CONNECTION NICKNAME &optional MODE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: mode (CONNECTION connection) (NICKNAME string) &optional MODE
Generic Function: modes OBJECT
Generic Function: (setf modes) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: modes (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf modes) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Method: modes (CHANNEL channel)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf modes) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: motd- CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: motd- (CONNECTION connection) &optional TARGET
Generic Function: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: name (CHANNEL channel)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf name) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: names CONNECTION CHANNEL &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: names (CONNECTION connection) (CHANNEL channel) &optional TARGET
Method: names (CONNECTION connection) (CHANNEL string) &optional TARGET
Generic Function: network-stream OBJECT
Generic Function: (setf network-stream) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: network-stream (DCC-CONNECTION dcc-connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf network-stream) NEW-VALUE (DCC-CONNECTION dcc-connection)

automatically generated writer method

Source

protocol.lisp (file)

Method: network-stream (CONNECTION connection)
Method: (setf network-stream) NEW-VALUE (CONNECTION connection)

Stream used to talk binary to the IRC server.

Source

protocol.lisp (file)

Generic Function: nick CONNECTION NEW-NICKNAME
Package

cl-irc

Source

command.lisp (file)

Methods
Method: nick (CONNECTION connection) (NEW-NICKNAME string)
Generic Function: nickname OBJECT
Generic Function: (setf nickname) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: nickname (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf nickname) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: normalized-name OBJECT
Generic Function: (setf normalized-name) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: normalized-name (CHANNEL channel)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf normalized-name) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: normalized-nickname OBJECT
Generic Function: (setf normalized-nickname) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: normalized-nickname (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf normalized-nickname) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: notice CONNECTION TARGET MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: notice (CONNECTION connection) (CHANNEL channel) (MESSAGE string)
Method: notice (CONNECTION connection) (USER user) (MESSAGE string)
Method: notice (CONNECTION connection) (TARGET string) (MESSAGE string)
Generic Function: op CONNECTION CHANNEL NICKNAME
Package

cl-irc

Source

command.lisp (file)

Methods
Method: op (CONNECTION connection) (CHANNEL channel) (USER user)
Method: op (CONNECTION connection) (CHANNEL string) (NICKNAME string)
Generic Function: oper CONNECTION NAME PASSWORD
Package

cl-irc

Source

command.lisp (file)

Methods
Method: oper (CONNECTION connection) (NAME string) (PASSWORD string)
Generic Function: output-stream OBJECT
Generic Function: (setf output-stream) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: output-stream (DCC-CHAT-CONNECTION dcc-chat-connection)
Method: (setf output-stream) NEW-VALUE (DCC-CHAT-CONNECTION dcc-chat-connection)

Stream used to communicate with the other end of the network pipe.

Source

protocol.lisp (file)

Method: output-stream (CONNECTION connection)
Method: (setf output-stream) NEW-VALUE (CONNECTION connection)

Stream used to send messages to the IRC server

Source

protocol.lisp (file)

Generic Function: part CONNECTION CHANNEL &optional REASON
Package

cl-irc

Source

command.lisp (file)

Methods
Method: part (CONNECTION connection) (CHANNEL channel) &optional REASON
Method: part (CONNECTION connection) (CHANNEL string) &optional REASON
Generic Function: part-all CONNECTION &optional REASON
Package

cl-irc

Source

command.lisp (file)

Methods
Method: part-all (CONNECTION connection) &optional REASON
Generic Function: pass CONNECTION PASSWORD
Package

cl-irc

Source

command.lisp (file)

Methods
Method: pass (CONNECTION connection) (PASSWORD string)

A "PASS" command is not required for a client connection to be registered, but it MUST precede the latter of the NICK/USER combination (for a user connection) or the SERVICE command (for a service connection). The RECOMMENDED order for a client to register is as follows:

1. Pass message
2. Nick message 2. Service message
3. User message

Upon success, the client will receive an RPL_WELCOME (for users) or RPL_YOURESERVICE (for services) message indicating that the connection is now registered and known the to the entire IRC network. The reply message MUST contain the full client identifier upon which it was registered.

Generic Function: password OBJECT
Generic Function: (setf password) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: password (CONNECTION connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf password) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: ping CONNECTION SERVER
Package

cl-irc

Source

command.lisp (file)

Methods
Method: ping (CONNECTION connection) (SERVER string)
Generic Function: pong CONNECTION SERVER &optional SERVER2
Package

cl-irc

Source

command.lisp (file)

Methods
Method: pong (CONNECTION connection) (SERVER string) &optional SERVER2
Generic Function: privmsg CONNECTION CHANNEL MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: privmsg (CONNECTION dcc-chat-connection) TARGET MESSAGE
Method: privmsg (CONNECTION connection) (CHANNEL channel) (MESSAGE string)
Method: privmsg (CONNECTION connection) (USER user) (MESSAGE string)
Method: privmsg (CONNECTION connection) (TARGET string) (MESSAGE string)
Generic Function: quit CONNECTION &optional MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: quit (CONNECTION dcc-chat-connection) &optional MESSAGE
Method: quit (CONNECTION connection) &optional MESSAGE
Generic Function: raw-message-string OBJECT
Generic Function: (setf raw-message-string) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: raw-message-string (DCC-MESSAGE dcc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf raw-message-string) NEW-VALUE (DCC-MESSAGE dcc-message)

automatically generated writer method

Source

protocol.lisp (file)

Method: raw-message-string (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf raw-message-string) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: read-irc-message CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: read-irc-message (CONNECTION connection)

Read and parse an IRC message from the ‘connection’.

Generic Function: read-message CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: read-message (CONNECTION dcc-chat-connection)
Method: read-message (CONNECTION connection)
Generic Function: read-message-loop CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: read-message-loop (CONNECTION dcc-chat-connection)
Method: read-message-loop CONNECTION
Generic Function: realname OBJECT
Generic Function: (setf realname) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: realname (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf realname) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: received-time OBJECT
Generic Function: (setf received-time) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: received-time (DCC-MESSAGE dcc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf received-time) NEW-VALUE (DCC-MESSAGE dcc-message)

automatically generated writer method

Source

protocol.lisp (file)

Method: received-time (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf received-time) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: rehash CONNECTION
Package

cl-irc

Source

command.lisp (file)

Methods
Method: rehash (CONNECTION connection)
Generic Function: remote-user OBJECT
Generic Function: (setf remote-user) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: remote-user (DCC-CONNECTION dcc-connection)
Method: (setf remote-user) NEW-VALUE (DCC-CONNECTION dcc-connection)

The user at the other end of this connection. The
user at this end can be reached via your normal connection object.

Source

protocol.lisp (file)

Generic Function: remove-all-channels CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-all-channels (CONNECTION connection)

Remove all channels known to ‘connection’.

Generic Function: remove-all-hooks CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-all-hooks (CONNECTION connection)
Generic Function: remove-all-users CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-all-users (CONNECTION connection)

Remove all users known to ‘connection’.

Generic Function: remove-channel CONNECTION CHANNEL
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-channel (USER user) (CHANNEL channel)

Remove ‘channel’ from ‘user’.

Method: remove-channel (CONNECTION connection) (CHANNEL channel)

Remove ‘channel’ from ‘connection’.

Generic Function: remove-hook CONNECTION CLASS HOOK
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-hook (CONNECTION connection) CLASS HOOK

Remove ‘hook’ from ‘class’.

Generic Function: remove-hooks CONNECTION CLASS
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-hooks (CONNECTION connection) CLASS

Remove all hooks for ‘class’.

Generic Function: remove-mode TARGET MODE-NAME

Remove the mode-holding object in the ‘mode-name’ key from ‘target’.

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-mode TARGET MODE-NAME
Generic Function: remove-user OBJECT USER
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: remove-user (CONNECTION connection) (USER user)

Remove ‘user’ from ‘connection’ but leave user in any channels he may be already be on.

Method: remove-user (CHANNEL channel) (USER user)

Remove ‘user’ from ‘channel’ and ‘channel’ from ‘user’.

Generic Function: restart- CONNECTION
Package

cl-irc

Source

command.lisp (file)

Methods
Method: restart- (CONNECTION connection)
Generic Function: self-message-p MESSAGE
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: self-message-p (MESSAGE irc-message)

Did we send this message?

Generic Function: server-name OBJECT
Generic Function: (setf server-name) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: server-name (CONNECTION connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf server-name) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: server-port OBJECT
Generic Function: (setf server-port) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: server-port (CONNECTION connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf server-port) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: service CONNECTION NICKNAME DISTRIBUTION INFO
Package

cl-irc

Source

command.lisp (file)

Methods
Method: service (CONNECTION connection) (NICKNAME string) (DISTRIBUTION string) (INFO string)
Generic Function: servlist CONNECTION &optional MASK TYPE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: servlist (CONNECTION connection) &optional MASK TYPE
Generic Function: set-mode TARGET MODE &optional PARAMETER

Set the mode designated by the ‘mode’ keyword to a value passed in ‘parameter’ or T if ‘parameter’ is absent.

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: set-mode TARGET MODE &optional PARAMETER
Generic Function: source OBJECT
Generic Function: (setf source) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: source (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf source) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: squery CONNECTION SERVICE-NAME TEXT
Package

cl-irc

Source

command.lisp (file)

Methods
Method: squery (CONNECTION connection) (SERVICE-NAME string) (TEXT string)
Generic Function: squit CONNECTION SERVER COMMENT
Package

cl-irc

Source

command.lisp (file)

Methods
Method: squit (CONNECTION connection) (SERVER string) (COMMENT string)
Generic Function: stats CONNECTION &optional QUERY TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: stats (CONNECTION connection) &optional QUERY TARGET
Generic Function: summon CONNECTION NICKNAME &optional TARGET CHANNEL
Package

cl-irc

Source

command.lisp (file)

Methods
Method: summon (CONNECTION connection) (NICKNAME string) &optional TARGET CHANNEL
Generic Function: time- CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: time- (CONNECTION connection) &optional TARGET
Generic Function: topic OBJECT
Generic Function: (setf topic) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: topic (CHANNEL channel)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf topic) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: topic- CONNECTION CHANNEL TOPIC
Package

cl-irc

Source

command.lisp (file)

Methods
Method: topic- (CONNECTION connection) (CHANNEL channel) (TOPIC string)
Method: topic- (CONNECTION connection) (CHANNEL string) (TOPIC string)
Generic Function: trace- CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: trace- (CONNECTION connection) &optional TARGET
Generic Function: trailing-argument MESSAGE
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: trailing-argument (MESSAGE irc-message)
Generic Function: unban CONNECTION CHANNEL MASK
Package

cl-irc

Source

command.lisp (file)

Methods
Method: unban (CONNECTION connection) (CHANNEL channel) (MASK string)
Method: unban (CONNECTION connection) (CHANNEL string) (MASK string)
Generic Function: unset-mode TARGET MODE &optional PARAMETER

Sets value of the mode designated by the ‘mode’ keyword to nil.
If the mode holds a list of values ‘parameter’ is used to indicate which element to remove.

Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: unset-mode TARGET MODE &optional PARAMETER
Generic Function: user OBJECT
Generic Function: (setf user) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: user (IRC-MESSAGE irc-message)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf user) NEW-VALUE (IRC-MESSAGE irc-message)

automatically generated writer method

Source

protocol.lisp (file)

Method: user (CONNECTION connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf user) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: user- CONNECTION USERNAME MODE &optional REALNAME
Package

cl-irc

Source

command.lisp (file)

Methods
Method: user- (CONNECTION connection) (USERNAME string) (MODE integer) &optional REALNAME
Generic Function: user-count OBJECT
Generic Function: (setf user-count) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: user-count (CHANNEL channel)
Method: (setf user-count) NEW-VALUE (CHANNEL channel)

May not represent the real number of users in the
channel. Rather, the number returned from the LIST command gets stuck in there so the user of this library can use it for searching channels, for instance. If the value is NIL then the slot has not been populated by a LIST command.

Source

protocol.lisp (file)

Generic Function: user-eq-me-p CONNECTION USER
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: user-eq-me-p CONNECTION (USER string)
Method: user-eq-me-p CONNECTION (USER user)
Generic Function: userhost CONNECTION NICKNAME
Package

cl-irc

Source

command.lisp (file)

Methods
Method: userhost (CONNECTION connection) (USER user)
Method: userhost (CONNECTION connection) (NICKNAME string)
Generic Function: username OBJECT
Generic Function: (setf username) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: username (USER user)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf username) NEW-VALUE (USER user)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: users OBJECT
Generic Function: (setf users) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: users (CHANNEL channel)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf users) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

protocol.lisp (file)

Method: users (CONNECTION connection)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf users) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: users- CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: users- (CONNECTION connection) &optional TARGET
Generic Function: version CONNECTION &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: version (CONNECTION connection) &optional TARGET
Generic Function: visibility OBJECT
Generic Function: (setf visibility) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: visibility (CHANNEL channel)

automatically generated reader method

Source

protocol.lisp (file)

Method: (setf visibility) NEW-VALUE (CHANNEL channel)

automatically generated writer method

Source

protocol.lisp (file)

Generic Function: voice CONNECTION CHANNEL USER
Package

cl-irc

Source

command.lisp (file)

Methods
Method: voice (CONNECTION connection) (CHANNEL channel) (USER user)
Method: voice (CONNECTION connection) (CHANNEL string) (NICKNAME string)
Generic Function: wallops CONNECTION MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: wallops (CONNECTION connection) (MESSAGE string)
Generic Function: who CONNECTION &optional MASK O
Package

cl-irc

Source

command.lisp (file)

Methods
Method: who (CONNECTION connection) &optional MASK O
Generic Function: whois CONNECTION MASK &optional TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: whois (CONNECTION connection) (MASK string) &optional TARGET
Generic Function: whowas CONNECTION NICKNAME &optional COUNT TARGET
Package

cl-irc

Source

command.lisp (file)

Methods
Method: whowas (CONNECTION connection) (NICKNAME string) &optional COUNT TARGET

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Conditions

Condition: no-such-reply ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

condition (condition)

Direct methods

reply-number (method)

Direct slots
Slot: reply-number
Initargs

:reply-number

Readers

reply-number (generic function)

Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: boolean-value-mode ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-mode (class)

Direct methods
Class: channel ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: normalized-name
Initargs

:normalized-name

Readers

normalized-name (generic function)

Writers

(setf normalized-name) (generic function)

Slot: topic
Initargs

:topic

Readers

topic (generic function)

Writers

(setf topic) (generic function)

Slot: modes
Initargs

:modes

Initform

(quote nil)

Readers

modes (generic function)

Writers

(setf modes) (generic function)

Slot: visibility
Type

(member nil :public :private :secret :unknown)

Initargs

:visibility

Readers

visibility (generic function)

Writers

(setf visibility) (generic function)

Slot: users
Initargs

:users

Initform

(make-hash-table :test (function equal))

Readers

users (generic function)

Writers

(setf users) (generic function)

Slot: user-count

May not represent the real number of users in the
channel. Rather, the number returned from the LIST command gets stuck in there so the user of this library can use it for searching channels, for instance. If the value is NIL then the slot has not been populated by a LIST command.

Initargs

:user-count

Readers

user-count (generic function)

Writers

(setf user-count) (generic function)

Class: connection ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: user
Initargs

:user

Readers

user (generic function)

Writers

(setf user) (generic function)

Slot: password
Initargs

:password

Readers

password (generic function)

Writers

(setf password) (generic function)

Slot: server-name
Initargs

:server-name

Initform

"unknown server"

Readers

server-name (generic function)

Writers

(setf server-name) (generic function)

Slot: server-port
Initargs

:server-port

Initform

cl-irc::*default-irc-server-port*

Readers

server-port (generic function)

Writers

(setf server-port) (generic function)

Slot: network-stream

Stream used to talk binary to the IRC server.

Initargs

:network-stream

Readers

network-stream (generic function)

Writers

(setf network-stream) (generic function)

Slot: output-stream

Stream used to send messages to the IRC server

Initargs

:output-stream

Readers

output-stream (generic function)

Writers

(setf output-stream) (generic function)

Slot: server-capabilities

Assoc array for rpl_isupport message;
see http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt

Initform

cl-irc::*default-isupport-values*

Readers

server-capabilities (generic function)

Writers

(setf server-capabilities) (generic function)

Slot: client-stream

Messages coming back from the server are sent to this stream.

Initargs

:client-stream

Initform

t

Readers

client-stream (generic function)

Writers

(setf client-stream) (generic function)

Slot: dcc-offers

The DCC offers sent out in association with this connection.

Initform

(quote nil)

Readers

dcc-offers (generic function)

Writers

(setf dcc-offers) (generic function)

Slot: dcc-connections

The DCC connections associated with this IRC connection.

Initform

(quote nil)

Readers

dcc-connections (generic function)

Writers

(setf dcc-connections) (generic function)

Slot: channels
Initargs

:channels

Initform

(make-hash-table :test (function equal))

Readers

channels (generic function)

Writers

(setf channels) (generic function)

Slot: hooks
Initargs

:hooks

Initform

(make-hash-table :test (function equal))

Readers

hooks (generic function)

Writers

(setf hooks) (generic function)

Slot: channel-mode-descriptions

Describes the modes an application intends to register with channels.

Initargs

:channel-mode-descriptions

Initform

(cl-irc::chanmode-descs-from-isupport cl-irc::*default-isupport-values*)

Readers

channel-mode-descriptions (generic function)

Writers

(setf channel-mode-descriptions) (generic function)

Slot: nick-prefixes
Initargs

:nick-prefixes

Initform

(cl-irc::nick-prefixes-from-isupport cl-irc::*default-isupport-values*)

Readers

nick-prefixes (generic function)

Writers

(setf nick-prefixes) (generic function)

Slot: user-mode-destriptions

Describes the modes an application intends to register with channels.

Initargs

:user-mode-descriptions

Initform

(mapcar (function (lambda (cl-irc::x) (cl-irc::make-mode-description :char (car cl-irc::x) :symbol (cdr cl-irc::x)))) cl-irc::*char-to-user-modes-map*)

Readers

user-mode-descriptions (generic function)

Writers

(setf user-mode-descriptions) (generic function)

Slot: users
Initargs

:users

Initform

(make-hash-table :test (function equal))

Readers

users (generic function)

Writers

(setf users) (generic function)

Class: ctcp-action-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: ctcp-dcc-chat-request-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods
Class: ctcp-dcc-send-request-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods

irc-message-event (method)

Class: ctcp-finger-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods

default-hook (method)

Class: ctcp-ping-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods

default-hook (method)

Class: ctcp-source-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods

default-hook (method)

Class: ctcp-time-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods

default-hook (method)

Class: ctcp-userinfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: ctcp-version-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods

default-hook (method)

Class: dcc-chat-connection ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

dcc-connection (class)

Direct methods
Direct slots
Slot: output-stream

Stream used to communicate with the other end of the network pipe.

Initargs

:output-stream

Readers

output-stream (generic function)

Writers

(setf output-stream) (generic function)

Slot: hooks
Initform

(make-hash-table :test (function equal))

Readers

hooks (generic function)

Writers

(setf hooks) (generic function)

Class: dcc-connection ()

Abstract superclass of all types of DCC connections.

This class isn’t meant to be instanciated. The different DCC subprotocols differ widely in the way they transmit their data, meaning there are relatively few methods which can be defined for this class. They do share a number of properties though.

Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

dcc-chat-connection (class)

Direct methods
Direct slots
Slot: irc-connection

The associated IRC connection used to send
CTCP control commands. When this connection is closed/lost, the DCC connection should be terminated too for security reasons.

Initargs

:irc-connection

Readers

irc-connection (generic function)

Writers

(setf irc-connection) (generic function)

Slot: close-on-main

Makes sure that the DCC connection is closed
as soon as either the IRC connection is actively closed or when a lost connection is detected.

Initargs

:close-on-main

Initform

t

Readers

close-on-main (generic function)

Writers

(setf close-on-main) (generic function)

Slot: remote-user

The user at the other end of this connection. The
user at this end can be reached via your normal connection object.

Initargs

:remote-user

Readers

remote-user (generic function)

Writers

(setf remote-user) (generic function)

Slot: network-stream
Initargs

:network-stream

Readers

network-stream (generic function)

Writers

(setf network-stream) (generic function)

Slot: client-stream

Input from the remote is sent to this stream.

Initargs

:client-stream

Readers

client-stream (generic function)

Writers

(setf client-stream) (generic function)

Class: dcc-ctcp-action-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-dcc-chat-request-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Direct methods
Class: dcc-ctcp-dcc-send-request-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-finger-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-ping-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-source-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-time-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-userinfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-ctcp-version-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses
Class: dcc-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: connection
Initargs

:connection

Readers

connection (generic function)

Writers

(setf connection) (generic function)

Slot: arguments
Type

list

Initargs

:arguments

Readers

arguments (generic function)

Writers

(setf arguments) (generic function)

Slot: received-time
Initargs

:received-time

Readers

received-time (generic function)

Writers

(setf received-time) (generic function)

Slot: raw-message-string
Type

string

Initargs

:raw-message-string

Readers

raw-message-string (generic function)

Writers

(setf raw-message-string) (generic function)

Class: dcc-privmsg-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

dcc-message (class)

Class: irc-err_alreadyregistered-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_badchanmask-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_badchanname-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_badchannelkey-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_badmask-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_banlistfull-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_bannedfromchan-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_bannickchange-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_blocking_notid-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_cannotsendtochan-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_cantkillserver-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_channelisfull-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_chanoprivsneeded-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_erroneusnickname-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_fileerror-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_ghostedclient-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_inviteonlychan-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_keyset-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_last_err_msg-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_maxforwarding-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_maxmapnodes-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_need_umode-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_needmoreparams-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nickcollision-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nicknameinuse-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_no_op_split-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_noadmininfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nochanmodes-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_noforwarding-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nologin-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nomotd-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nonicknamegiven-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nooperhost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_noorigin-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nopermforhost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_noprivileges-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_norecipient-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nosuchchannel-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nosuchnick-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nosuchserver-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nosuchservice-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_notexttosend-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_notonchannel-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_notoplevel-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_notregistered-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_nounidentified-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_passwdmismatch-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_restricted-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_services_offline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_sitelistfull-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_sourceninvite-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_summondisabled-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_targetninvite-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_throttled-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_toomanychannels-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_toomanytargets-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_umodeunknownflag-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_unavailresource-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_uniqopprivsneeded-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_unknowncommand-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_unknownmode-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_userdisabled-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_usernotinchannel-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_useronchannel-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_usersdontmatch-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_wasnosuchnick-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_wildtoplevel-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_yourebannedcreep-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-err_youwillbebanned-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-error-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-invite-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-join-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-kick-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-kill-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: source
Type

string

Initargs

:source

Readers

source (generic function)

Writers

(setf source) (generic function)

Slot: user
Initargs

:user

Readers

user (generic function)

Writers

(setf user) (generic function)

Slot: host
Type

string

Initargs

:host

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: command
Type

string

Initargs

:command

Readers

command (generic function)

Writers

(setf command) (generic function)

Slot: arguments
Type

list

Initargs

:arguments

Readers

arguments (generic function)

Writers

(setf arguments) (generic function)

Slot: connection
Initargs

:connection

Readers

connection (generic function)

Writers

(setf connection) (generic function)

Slot: received-time
Initargs

:received-time

Readers

received-time (generic function)

Writers

(setf received-time) (generic function)

Slot: raw-message-string
Type

string

Initargs

:raw-message-string

Readers

raw-message-string (generic function)

Writers

(setf raw-message-string) (generic function)

Class: irc-mode ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: value
Initargs

:value

Readers

value (generic function)

Writers

(setf value) (generic function)

Slot: value-type

The framework sets this to ‘:user’ or ‘:non-user’.
Essentially, if it’s ‘:user’, the value(s) held must be derived from the user class.

Initargs

:value-type

Readers

value-type (generic function)

Writers

(setf value-type) (generic function)

Class: irc-mode-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-nick-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-notice-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-part-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-ping-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-pong-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-privmsg-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-quit-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_adminemail-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_adminloc1-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_adminloc2-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_adminme-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_away-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_banlist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_bounce-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_channel_url-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_channelmodeis-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_clientcapab-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_closeend-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_closing-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_created-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_creationtime-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endmode-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofbanlist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_endofexceptlist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_endofinfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofinvitelist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_endoflinks-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofmap-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofmotd-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofnames-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_endofservices-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofstats-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofusers-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofwho-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofwhois-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endofwhowas-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endoptions-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_endsitelist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_exceptlist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_forward-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_globalusers-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_hello-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_hiddenhost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_info-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_infostart-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_invitelist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_inviting-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_ison-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_isupport-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_killdone-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_knock-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_links-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_list-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_listend-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_liststart-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_localusers-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_luserchannels-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_luserclient-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_luserme-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_luserop-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_luserunknown-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_map-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_mapend-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_mapstart-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_message-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_mode-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_motd-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_motdstart-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_myinfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_myportis-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_namreply-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_noaway-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_none-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_noservicehost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_notopic-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_nousers-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_option-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_rehashing-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_savenick-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_secureconnection-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_service-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_serviceinfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_servlist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_servlistend-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_sitelist-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsbline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statscline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statscommands-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsdebug-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsdline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statshline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsiline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statskline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statslinkinfo-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statslline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsnline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsonline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsping-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsqline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statssline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsuline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsuptime-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsvline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_statsyline-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_summoning-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_time-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_topic-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_topicwhotime-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceclass-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceconnecting-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceend-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_tracehandshake-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_tracelink-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_tracelog-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_tracenewtype-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceoperator-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_tracereconnect-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceserver-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceservice-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceunknown-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_traceuser-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_tryagain-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_umodeis-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_unaway-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_uniqopis-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_userhost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_users-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_usersstart-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_version-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_welcome-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_whoischannels-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoischanop-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisidentified-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisidle-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisoperator-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisoperprivs-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisrealhost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisserver-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whoisuser-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: irc-rpl_whoreply-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_whowasuser-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_youreoper-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_yourhost-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_yourid-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-rpl_yourservice-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Class: irc-topic-message ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-message (class)

Direct methods

default-hook (method)

Class: list-value-mode ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-mode (class)

Direct methods
Class: single-value-mode ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

irc-mode (class)

Direct methods
Class: user ()
Package

cl-irc

Source

protocol.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: nickname
Initargs

:nickname

Initform

""

Readers

nickname (generic function)

Writers

(setf nickname) (generic function)

Slot: normalized-nickname
Initargs

:normalized-nickname

Initform

""

Readers

normalized-nickname (generic function)

Writers

(setf normalized-nickname) (generic function)

Slot: username
Initargs

:username

Initform

""

Readers

username (generic function)

Writers

(setf username) (generic function)

Slot: hostname
Initargs

:hostname

Initform

""

Readers

hostname (generic function)

Writers

(setf hostname) (generic function)

Slot: realname
Initargs

:realname

Initform

""

Readers

realname (generic function)

Writers

(setf realname) (generic function)

Slot: modes
Initargs

:modes

Initform

(quote nil)

Readers

modes (generic function)

Writers

(setf modes) (generic function)

Slot: channels
Initargs

:channels

Readers

channels (generic function)

Writers

(setf channels) (generic function)

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions

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

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +soh+
Package

cl-irc

Source

variable.lisp (file)

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Special variables

Special Variable: *char-to-user-modes-map*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *ctcp-version*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *dcc-connections*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *debug-p*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *debug-stream*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-char-to-channel-modes-map*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-incoming-external-formats*

The external-formats we use to decode incoming messages. This should be a list of external format specs that flexi-streams accepts.

The external formats are tried in order, until one decodes the message without encoding errors. Note that the last external format should be a single-byte one with most or even all valid codepoints (such as latin-1).

:eol-style will always be overridden to be :crlf as required by the IRC protocol.

Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-irc-server*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-irc-server-port*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-isupport-chanmodes*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-isupport-prefix*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-isupport-values*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-nickname*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-outgoing-external-format*

The external-format we use to encode outgoing messages. This should be an external format spec that flexi-streams accepts.

:eol-style will always be overridden to be :crlf as required by the IRC protocol.

Package

cl-irc

Source

variable.lisp (file)

Special Variable: *default-quit-message*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *download-directory*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *download-file*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *download-host*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *passive-offer-sequence-token*
Package

cl-irc

Source

command.lisp (file)

Special Variable: *process-count*
Package

cl-irc

Source

protocol.lisp (file)

Special Variable: *reply-names*
Package

cl-irc

Source

variable.lisp (file)

Special Variable: *unknown-reply-hook*

A function of two arguments, called with the related irc connection object and the protocol message string upon detection of an unmappable response code.

The function should return a valid IRC-MESSAGE class or NIL.

The parameter can be NIL to disable the hook.

Package

cl-irc

Source

variable.lisp (file)

Special Variable: *version*
Package

cl-irc

Source

variable.lisp (file)

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Macros

Macro: create-ctcp-message-classes CLASS-LIST
Package

cl-irc

Source

protocol.lisp (file)

Macro: create-irc-message-classes CLASS-LIST
Package

cl-irc

Source

protocol.lisp (file)

Macro: do-property-list (PROP VAL LIST) &body BODY
Package

cl-irc

Source

utility.lisp (file)

Macro: dynfound-funcall (SYMBOL-NAME &optional PACKAGE) &rest PARAMETERS
Package

cl-irc

Source

utility.lisp (file)

Macro: generate-maskmode-hooks LISTMSG-CLASS ENDMSG-CLASS TMP-SYMBOL MODE-SYMBOL
Package

cl-irc

Source

event.lisp (file)

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Functions

Function: apply-mode-change CONNECTION TARGET CHANGE
Package

cl-irc

Source

utility.lisp (file)

Function: canonicalize-nickname CONNECTION NICKNAME
Package

cl-irc

Source

protocol.lisp (file)

Function: chanmode-descs-from-isupport ISUPPORT-ARGUMENTS &optional MODE-SYMBOLS

Parses a string describing channel modes conforming to http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt paragraph 3.3.

It returns a list of mode-description records.

Package

cl-irc

Source

utility.lisp (file)

Function: combine-arguments-and-trailing STRING &key START
Package

cl-irc

Source

parse-message.lisp (file)

Function: copy-mode-description INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: create-dcc-message STRING
Package

cl-irc

Source

parse-message.lisp (file)

Function: create-irc-message STRING

If ‘string’ is a valid IRC message parse it and return an object of the correct type with its slots prefilled according to the information in the message.

Package

cl-irc

Source

parse-message.lisp (file)

Function: ctcp-message-type STRING

If ‘string’ is a CTCP message, return the type of the message or nil if this is a) not a CTCP message or b) a CTCP message we don’t know about.

Package

cl-irc

Source

parse-message.lisp (file)

Function: ctcp-type-p STRING TYPE

Is the ‘string’ actually a representation of the CTCP ‘type’?

Package

cl-irc

Source

parse-message.lisp (file)

Function: cut-before STRING SUBSTRING END-CHARS &key START CUT-EXTRA CUT-TO-END

Cut ‘string’ before ‘substring’ or any of the ‘end-chars’, from ‘start’, if none of substring or end-chars are found, until the end of the string when ‘cut-to-end’ is true.

If ‘cut-extra’ is t, we will cut from start + 1 instead of just ‘start’.

When there is no string matching the input parameters ‘start’ and nil will be returned, otherwise ‘end-position’ and the string are returned.

Package

cl-irc

Source

utility.lisp (file)

Function: cut-between STRING START-CHAR END-CHARS &key START CUT-EXTRA CUT-TO-END

If ‘start-char’ is not nil, cut string between ‘start-char’ and any
of the ‘end-chars’, from ‘start’. If ‘start-char’ is nil, cut from ‘start’ until any of the ‘end-chars’ (or sting-end when ‘cut-to-end’ is true).

If ‘cut-extra’ is t, we will cut from start + 1 instead of just
‘start’.

When there is no string matching the input parameters ‘start’ and nil
will be returned, otherwise ‘end-position’ and the string are
returned.

Package

cl-irc

Source

utility.lisp (file)

Function: dcc-type-p STRING TYPE

Is the ‘string’ actually a representation of the DCC ‘type’?

Package

cl-irc

Source

parse-message.lisp (file)

Function: define-ctcp-message CTCP-COMMAND
Package

cl-irc

Source

protocol.lisp (file)

Function: define-dcc-ctcp-message CTCP-COMMAND
Package

cl-irc

Source

protocol.lisp (file)

Function: define-irc-message COMMAND
Package

cl-irc

Source

protocol.lisp (file)

Function: do-mask-match MASK HOSTNAME MASK-CONSUMED HOST-CONSUMED
Package

cl-irc

Source

utility.lisp (file)

Function: external-format-fixup FORMAT
Package

cl-irc

Source

utility.lisp (file)

Function: get-day-name DAY-NUMBER

Given a number, such as 1, return the appropriate day name, abbrevated, such as "Tue". Index 0 is Monday.

Package

cl-irc

Source

utility.lisp (file)

Function: get-month-name MONTH-NUMBER

Index 1 is January.

Package

cl-irc

Source

utility.lisp (file)

Function: hbo-to-dotted-quad INTEGER

Host-byte-order integer to dotted-quad string conversion utility.

Package

cl-irc

Source

utility.lisp (file)

Function: hbo-to-vector-quad INTEGER

Host-byte-order integer to dotted-quad string conversion utility.

Package

cl-irc

Source

utility.lisp (file)

Function: host-byte-order STRING

Convert a string, such as 192.168.1.1, to host-byte-order, such as 3232235777.

Package

cl-irc

Source

utility.lisp (file)

Function: intern-message-symbol PREFIX NAME

Intern based on symbol-name to support case-sensitive mlisp

Package

cl-irc

Source

protocol.lisp (file)

Function: irc-error-reply-p STRING

Returns t if ‘string’ is a string-representation of an IRC error reply message, nil otherwise.

Package

cl-irc

Source

parse-message.lisp (file)

Function: list-of-strings-to-integers LIST

Take a list of strings and return a new list of integers (from parse-integer) on each of the string elements.

Package

cl-irc

Source

utility.lisp (file)

Function: make-ctcp-message STRING

Return a valid IRC CTCP message, as a string, composed by ‘string’.

Package

cl-irc

Source

utility.lisp (file)

Function: make-irc-message COMMAND &rest ARGUMENTS

Return a valid IRC message, as a string, composed of the input parameters.

Package

cl-irc

Source

utility.lisp (file)

Function: make-mode-description &key (CHAR CHAR) (SYMBOL SYMBOL) (PARAM-ON-SET-P PARAM-ON-SET-P) (PARAM-ON-UNSET-P PARAM-ON-UNSET-P) (NICK-PARAM-P NICK-PARAM-P) (CLASS CLASS)
Package

cl-irc

Source

variable.lisp (file)

Function: make-time-message SECOND MINUTE HOUR DATE MONTH YEAR DAY

Returns a string composed of the input parameters so that it represents a time message as by the IRC protocol.

Package

cl-irc

Source

utility.lisp (file)

Function: matches-offer-by-token-p OFFER TOKEN
Package

cl-irc

Source

command.lisp (file)

Function: matches-offer-by-user-p OFFER USER
Package

cl-irc

Source

command.lisp (file)

Function: mode-desc-char INSTANCE
Function: (setf mode-desc-char) VALUE INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: mode-desc-class INSTANCE
Function: (setf mode-desc-class) VALUE INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: mode-desc-nick-param-p INSTANCE
Function: (setf mode-desc-nick-param-p) VALUE INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: mode-desc-param-on-set-p INSTANCE
Function: (setf mode-desc-param-on-set-p) VALUE INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: mode-desc-param-on-unset-p INSTANCE
Function: (setf mode-desc-param-on-unset-p) VALUE INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: mode-desc-symbol INSTANCE
Function: (setf mode-desc-symbol) VALUE INSTANCE
Package

cl-irc

Source

variable.lisp (file)

Function: mode-description-p OBJECT
Package

cl-irc

Source

variable.lisp (file)

Function: nick-prefixes-from-isupport ISUPPORT-ARGUMENTS

Returns an assoc list associating prefix characters with mode characters.

Package

cl-irc

Source

utility.lisp (file)

Function: numeric-reply-p STRING

Returns t if ‘string’ is a string-representation of an IRC number reply, nil otherwise.

Package

cl-irc

Source

parse-message.lisp (file)

Function: offer-matches-message-p OFFER MESSAGE-NICK MESSAGE-TYPE MESSAGE-TOKEN
Package

cl-irc

Source

command.lisp (file)

Function: parse-isupport-multivalue-argument ARGUMENT
Package

cl-irc

Source

utility.lisp (file)

Function: parse-isupport-prefix-argument PREFIX
Package

cl-irc

Source

utility.lisp (file)

Function: read-byte-no-hang ()
Package

cl-irc

Source

utility.lisp (file)

Function: read-protocol-line CONNECTION

Reads a line from the input network stream, returning a character array with the input read.

Package

cl-irc

Source

utility.lisp (file)

Function: read-sequence-until STREAM TARGET LIMIT &key NON-BLOCKING

Reads data from ‘stream’ into ‘target’ until the subsequence ‘limit’ is reached or ‘target’ is not large enough to hold the data.

Package

cl-irc

Source

utility.lisp (file)

Function: return-arguments STRING &key START

Assuming ‘string’ is a valid IRC message this function returns the arguments part of the message as a list. Returns nil if the arguments part is not present.

Package

cl-irc

Source

parse-message.lisp (file)

Function: return-command STRING &key START

Assuming ‘string’ is a valid IRC message this function returns the command part of the message. Returns nil if the command part is not present.

Package

cl-irc

Source

parse-message.lisp (file)

Function: return-host STRING &key START

Assuming ‘string’ is a valid IRC message this function returns the host part of the message. Returns nil if the host part is not present.

Package

cl-irc

Source

parse-message.lisp (file)

Function: return-source STRING &key START

Assuming ‘string’ is a valid IRC message this function returns the source part of the message. Returns nil if the source part is not present.

Package

cl-irc

Source

parse-message.lisp (file)

Function: return-trailing-argument STRING &key START

Assuming ‘string’ is a valid IRC message this function returns the trailing-argument part of the message. Returns nil if the trailing-argument part is not present.

Package

cl-irc

Source

parse-message.lisp (file)

Function: return-user STRING &key START

Assuming ‘string’ is a valid IRC message this function returns the user part of the message. Returns nil if the user part is not present.

Package

cl-irc

Source

parse-message.lisp (file)

Function: start-process FUNCTION NAME

Internal helper for the DEPRECATED function START-BACKGROUND-MESSAGE-HANDLER and therefore DEPRECATED itself.

Package

cl-irc

Source

protocol.lisp (file)

Function: substring STRING START &optional END
Package

cl-irc

Source

utility.lisp (file)

Function: tokenize-string STRING &key DELIMITERS

Split string into a list, splitting on ‘delimiters’ and removing any empty subsequences.

Package

cl-irc

Source

utility.lisp (file)

Function: try-decode-line LINE EXTERNAL-FORMATS
Package

cl-irc

Source

utility.lisp (file)

Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Generic functions

Generic Function: action CONNECTION TARGET MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: action (CONNECTION connection) (CHANNEL channel) (MESSAGE string)
Method: action (CONNECTION connection) (USER user) (MESSAGE string)
Method: action (CONNECTION connection) (TARGET string) (MESSAGE string)
Generic Function: apply-to-hooks MESSAGE
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: apply-to-hooks MESSAGE

Applies any applicable hooks to ‘message’.

Returns non-nil if any of the hooks do.

Generic Function: case-map-name CONNECTION
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: case-map-name (CONNECTION connection)
Generic Function: channel-mode-descriptions OBJECT
Generic Function: (setf channel-mode-descriptions) NEW-VALUE OBJECT
Package

cl-irc

Methods
Method: channel-mode-descriptions (CONNECTION connection)
Method: (setf channel-mode-descriptions) NEW-VALUE (CONNECTION connection)

Describes the modes an application intends to register with channels.

Source

protocol.lisp (file)

Generic Function: client-raw-log CONNECTION MESSAGE
Package

cl-irc

Source

protocol.lisp (file)

Methods
Method: client-raw-log (CONNECTION connection) MESSAGE
Generic Function: ctcp CONNECTION TARGET MESSAGE
Package

cl-irc

Source

command.lisp (file)

Methods
Method: ctcp (CONNECTION connection) TARGET MESSAGE
Generic Function: ctcp-command OBJECT