The lichat-serverlib Reference Manual

Table of Contents

The lichat-serverlib Reference Manual

This is the lichat-serverlib Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:05:15 2018 GMT+0.

1 Introduction

About Lichat-Serverlib

This is an implementation of the server-side protocol part of the Lichat protocol. It provides an extensible, transport-agnostic implementation that can be used to base a functional server on. All that the real server needs to take care of is the underlying connection establishment and reading.

You do not need this library if you are looking to implement a client. You don't need it if you're looking to implement a server either, but it will take care of a large part of the implementation tasks for you if you do use it.

Implementing an Overarching Server

In order to implement an actual server, you will want to do the following:

• Subclass at least server and connection.
• Provide functions to start a listener on a server instance.
• For each client that connects, create a connection object.
• Provide functions to repeatedly read updates from a connection and send them to process.
• Supply an after method on teardown-connection that closes the connection to the client properly.
• Provide a primary method for send specialised on your connection subclass that handles the actual wire transmission of an update.
• Handle potential synchronisation or mutual-exclusion issues to users, channels, profiles, and connections on the server if your server is multi-threaded.

For a simple illustrative example, see the lichat-tcp-server.

Also See

• lichat-protocol The Lichat protocol specification.
• lichat-tcp-server A basic, threaded, TCP-based implementation of a Lichat server.
• lichat-tcp-client A basic, threaded, TCP-based implementation of a Lichat client.
• LionChat A Qt GUI client for a TCP server.

2 Systems

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

2.1 lichat-serverlib

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shirakumo/lichat-serverlib

License

Artistic

Description

Tools to help build a server using the lichat protocol.

Version

1.0.0

Dependencies

• lichat-protocol
• crypto-shortcuts
• trivial-mimes
• documentation-utils

Source

lichat-serverlib.asd (file)

Components

• package.lisp (file)
• server-objects.lisp (file)
• server-operations.lisp (file)
• connection-maintenance.lisp (file)
• update-handlers.lisp (file)
• emotes.lisp (file)
• documentation.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 lichat-serverlib.asd

Location

lichat-serverlib.asd

Systems

lichat-serverlib (system)

3.1.2 lichat-serverlib/package.lisp

Parent

lichat-serverlib (system)

Location

package.lisp

Packages

lichat-serverlib

3.1.3 lichat-serverlib/server-objects.lisp

Dependency

package.lisp (file)

Parent

lichat-serverlib (system)

Location

server-objects.lisp

Exported Definitions

• alive-p (method)
• allowed-content-types (method)
• (setf allowed-content-types) (method)
• backlog (method)
• (setf backlog) (method)
• backlogged-channel (class)
• channel (class)
• channels (method)
• (setf channels) (method)
• coerce-channelname (function)
• coerce-username (function)
• connection (class)
• default-read-limit (method)
• (setf default-read-limit) (method)
• find-channel (method)
• (setf find-channel) (method)
• find-profile (method)
• (setf find-profile) (method)
• find-user (method)
• (setf find-user) (method)
• flood-frame (method)
• (setf flood-frame) (method)
• flood-limit (method)
• (setf flood-limit) (method)
• flood-protected-connection (class)
• flood-protected-server (class)
• frame-count (method)
• (setf frame-count) (method)
• idle-timeout (method)
• (setf idle-timeout) (method)
• join-times (method)
• (setf join-times) (method)
• last-frame (method)
• (setf last-frame) (method)
• last-update (method)
• (setf last-update) (method)
• list-channels (method)
• list-profiles (method)
• list-users (method)
• make-channel (method)
• make-connection (method)
• make-connection (method)
• make-profile (method)
• make-user (method)
• profile (class)
• profiles (method)
• (setf profiles) (method)
• read-limit (method)
• (setf read-limit) (method)
• remove-channel (method)
• remove-profile (method)
• remove-user (method)
• reset-timeout (method)
• salt (method)
• (setf salt) (method)
• server (method)
• (setf server) (method)
• (setf server) (method)
• server (class)
• start-timeout (method)
• timeout (method)
• (setf timeout) (method)
• timeoutable (class)
• user (class)
• users (method)
• (setf users) (method)

Internal Definitions

make-ring (function)

3.1.4 lichat-serverlib/server-operations.lisp

Dependency

server-objects.lisp (file)

Parent

lichat-serverlib (system)

Location

server-operations.lisp

Exported Definitions

• check-channel (function)
• check-channelname (function)
• check-from (function)
• check-permitted (function)
• check-target (function)
• create (method)
• init-connection (method)
• join (method)
• join (method)
• leave (method)
• leave (method)
• permitted (function)
• prep-perms (function)
• register (method)
• rule-permitted (function)
• teardown-connection (method)

3.1.5 lichat-serverlib/connection-maintenance.lisp

Dependency

server-operations.lisp (file)

Parent

lichat-serverlib (system)

Location

connection-maintenance.lisp

Exported Definitions

• check-connection-timeout (method)
• fail! (function)
• failure-args (method)
• failure-condition (condition)
• failure-type (method)
• pass-flood-gate (method)
• pass-flood-gate (method)
• process (method)
• process (method)
• process (method)
• send (method)
• send (method)
• send (method)
• send (method)
• send! (compiler macro)
• send! (function)

Internal Definitions

• fail!! (function)
• severe-failure-condition (condition)

3.1.6 lichat-serverlib/update-handlers.lisp

Dependency

connection-maintenance.lisp (file)

Parent

lichat-serverlib (system)

Location

update-handlers.lisp

Exported Definitions

• define-update-handler (macro)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)

3.1.7 lichat-serverlib/emotes.lisp

Dependency

update-handlers.lisp (file)

Parent

lichat-serverlib (system)

Location

emotes.lisp

Exported Definitions

• *allowed-emote-content-types* (special variable)
• add-emote (function)
• add-emotes (function)
• emote (function)
• (setf emote) (function)
• process (method)
• remove-emote (function)

Internal Definitions

• *emotes* (special variable)
• coerce-emote (function)
• coerce-emote-data (function)

3.1.8 lichat-serverlib/documentation.lisp

Dependency

emotes.lisp (file)

Parent

lichat-serverlib (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 lichat-serverlib

Source

package.lisp (file)

Nickname

org.shirakumo.lichat.serverlib

Use List

common-lisp

Exported Definitions

• *allowed-emote-content-types* (special variable)
• add-emote (function)
• add-emotes (function)
• alive-p (generic function)
• alive-p (method)
• allowed-content-types (generic function)
• allowed-content-types (method)
• (setf allowed-content-types) (method)
• (setf allowed-content-types) (generic function)
• backlog (generic function)
• backlog (method)
• (setf backlog) (method)
• (setf backlog) (generic function)
• backlogged-channel (class)
• channel (class)
• channels (generic function)
• channels (method)
• (setf channels) (method)
• (setf channels) (generic function)
• check-channel (function)
• check-channelname (function)
• check-connection-timeout (generic function)
• check-connection-timeout (method)
• check-from (function)
• check-permitted (function)
• check-target (function)
• coerce-channelname (function)
• coerce-username (function)
• connection (class)
• create (generic function)
• create (method)
• default-read-limit (generic function)
• default-read-limit (method)
• (setf default-read-limit) (method)
• (setf default-read-limit) (generic function)
• define-update-handler (macro)
• emote (function)
• (setf emote) (function)
• fail! (function)
• failure-args (generic function)
• failure-args (method)
• failure-condition (condition)
• failure-type (generic function)
• failure-type (method)
• find-channel (generic function)
• find-channel (method)
• (setf find-channel) (method)
• (setf find-channel) (generic function)
• find-profile (generic function)
• find-profile (method)
• (setf find-profile) (method)
• (setf find-profile) (generic function)
• find-user (generic function)
• find-user (method)
• (setf find-user) (method)
• (setf find-user) (generic function)
• flood-frame (generic function)
• flood-frame (method)
• (setf flood-frame) (method)
• (setf flood-frame) (generic function)
• flood-limit (generic function)
• flood-limit (method)
• (setf flood-limit) (method)
• (setf flood-limit) (generic function)
• flood-protected-connection (class)
• flood-protected-server (class)
• frame-count (generic function)
• frame-count (method)
• (setf frame-count) (method)
• (setf frame-count) (generic function)
• idle-timeout (generic function)
• idle-timeout (method)
• (setf idle-timeout) (method)
• (setf idle-timeout) (generic function)
• init-connection (generic function)
• init-connection (method)
• join (generic function)
• join (method)
• join (method)
• join-times (generic function)
• join-times (method)
• (setf join-times) (method)
• (setf join-times) (generic function)
• last-frame (generic function)
• last-frame (method)
• (setf last-frame) (method)
• (setf last-frame) (generic function)
• last-update (generic function)
• last-update (method)
• (setf last-update) (method)
• (setf last-update) (generic function)
• leave (generic function)
• leave (method)
• leave (method)
• list-channels (generic function)
• list-channels (method)
• list-profiles (generic function)
• list-profiles (method)
• list-users (generic function)
• list-users (method)
• make-channel (generic function)
• make-channel (method)
• make-connection (generic function)
• make-connection (method)
• make-connection (method)
• make-profile (generic function)
• make-profile (method)
• make-user (generic function)
• make-user (method)
• pass-flood-gate (generic function)
• pass-flood-gate (method)
• pass-flood-gate (method)
• permitted (function)
• prep-perms (function)
• process (generic function)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• profile (class)
• profiles (generic function)
• profiles (method)
• (setf profiles) (method)
• (setf profiles) (generic function)
• read-limit (generic function)
• read-limit (method)
• (setf read-limit) (method)
• (setf read-limit) (generic function)
• register (generic function)
• register (method)
• remove-channel (generic function)
• remove-channel (method)
• remove-emote (function)
• remove-profile (generic function)
• remove-profile (method)
• remove-user (generic function)
• remove-user (method)
• reset-timeout (generic function)
• reset-timeout (method)
• rule-permitted (function)
• salt (generic function)
• salt (method)
• (setf salt) (method)
• (setf salt) (generic function)
• send (generic function)
• send (method)
• send (method)
• send (method)
• send (method)
• send! (compiler macro)
• send! (function)
• server (generic function)
• server (method)
• (setf server) (method)
• (setf server) (generic function)
• (setf server) (method)
• server (class)
• start-timeout (generic function)
• start-timeout (method)
• teardown-connection (generic function)
• teardown-connection (method)
• timeout (generic function)
• timeout (method)
• (setf timeout) (method)
• (setf timeout) (generic function)
• timeoutable (class)
• user (class)
• users (generic function)
• users (method)
• (setf users) (method)
• (setf users) (generic function)

Internal Definitions

• *emotes* (special variable)
• coerce-emote (function)
• coerce-emote-data (function)
• fail!! (function)
• make-ring (function)
• severe-failure-condition (condition)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *allowed-emote-content-types*

Package

lichat-serverlib

Source

emotes.lisp (file)

5.1.2 Macros

Macro: define-update-handler TYPE (CONNECTION UPDATE) &body BODY

Easy wrapper to define a handler method for an update on a connection.

UPDATE is coerced to a symbol found in the LICHAT-PROTOCOL package.

This creates a PROCESS method.

See PROCESS

Package

lichat-serverlib

Source

update-handlers.lisp (file)

5.1.3 Compiler macros

Compiler Macro: send! CONNECTION TYPE-ISH &rest INITARGS

Package

lichat-serverlib

Source

connection-maintenance.lisp (file)

5.1.4 Functions

Function: add-emote PATHNAME

Package

lichat-serverlib

Source

emotes.lisp (file)

Function: add-emotes DIRECTORY

Package

lichat-serverlib

Source

emotes.lisp (file)

Function: check-channel CONNECTION UPDATE &optional MUST-BE-IN

Checks whether the CHANNEL field is a valid channel.

If the channel does not exist, a FAILURE-CONDITION for a LICHAT-PROTOCOL:NO-SUCH-CHANNEL failure is signalled. If it does exist, but the user is not a part of it, a FAILURE CONDITION for a LICHAT-PROTOCOL:NOT-IN-CHANNEL failure is signalled. Otherwise, the corresponding channel object is returned.

This is in accordance with §5.1.5 §5.4.2 §5.4.3 §5.4.4 §5.4.5

See LICHAT-PROTOCOL:NO-SUCH-CHANNEL
See LICHAT-PROTOCOL:NOT-IN-CHANNEL
See FIND-CHANNEL

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: check-channelname CONNECTION UPDATE

Checks whether the CHANNEL field has a valid, unused name.

If the channel name is malformed, a FAILURE-CONDITION for a LICHAT-PROTOCOL:BAD-NAME failure is signalled. If it is valid, but a channel of that name already exists, a FAILURE- CONDITION for a LICHAT-PROTOCOL:CHANNELNAME-TAKEN failure is signalled.

This is in accordance with §5.1.3 §5.3.2

See LICHAT-PROTOCOL:BAD-NAME
See LICHAT-PROTOCOL:CHANNELNAME-TAKEN
See FIND-CHANNEL
See LICHAT-PROTOCOL:CHANNELNAME-P

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: check-from CONNECTION UPDATE

Checks whether the FROM field matches the update.

If it is not, a FAILURE-CONDITION for a LICHAT-PROTOCOL: USERNAME-MISMATCH failure is signalled. If it is, the corresponding user object is returned.

This is in accordance with §5.1.4

See LICHAT-PROTOCOL:USERNAME-MISMATCH
See FIND-USER

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: check-permitted CONNECTION UPDATE &optional CHANNEL

Checks whether the given update is permitted.

If it is not, a FAILURE-CONDITION for a LICHAT-PROTOCOL: INSUFFICIENT-PERMISSIONS failure is signalled.

This is in accordance with §5.1.7

See PERMITTED
See LICHAT-PROTOCOL:INSUFFICIENT-PERMISSIONS

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: check-target CONNECTION UPDATE

Checks whether the TARGET field is a valid user.

If it is not, a FAILURE-CONDITION for a LICHAT-PROTOCOL: NO-SUCH-USER failure is signalled. If it is, the corresponding user object is returned.

This is in accordance with §5.1.6

See LICHAT-PROTOCOL:NO-SUCH-USER
See FIND-USER

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: coerce-channelname NAME-ISH

Attempt to coerce the name-ish to a channel name.

Valid types are: LICHAT-PROTOCOL:CHANNEL-UPDATE LICHAT-PROTOCOL:CHANNEL
STRING

Package

lichat-serverlib

Source

server-objects.lisp (file)

Function: coerce-username NAME-ISH

Attempt to coerce the name-ish to a user name.

Valid types are:
LICHAT-PROTOCOL:UPDATE LICHAT-PROTOCOL:USER
STRING

Package

lichat-serverlib

Source

server-objects.lisp (file)

Function: emote NAME

Function: (setf emote) EMOTE NAME

Package

lichat-serverlib

Source

emotes.lisp (file)

Function: fail! TYPE-ISH &rest INITARGS

Signal a FAILURE-CONDITION that carries the designated failure and sends it off to the client.

See FAILURE-CONDITION

Package

lichat-serverlib

Source

connection-maintenance.lisp (file)

Function: permitted ACTION CHANNEL USER

Returns true if the action on the channel by the user is permitted.

Action should be the class-name of an update.

See RULE-PERMITTED
See LICHAT-PROTOCOL:PERMISSIONS

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: prep-perms REGISTRANT PERMS

Prepare the list of permissions rule for the registrant.

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: remove-emote NAME

Package

lichat-serverlib

Source

emotes.lisp (file)

Function: rule-permitted RULE NAME

Checks whether the given rule allows the user of the given name access.

The rule evaluation is implemented according to §2.5

Package

lichat-serverlib

Source

server-operations.lisp (file)

Function: send! CONNECTION TYPE-ISH &rest INITARGS

Convenience function to send an update to a connection.

Specifically, this will:
* Coerce the type-ish to a protocol type by looking the symbol up in the lichat-protocol package.
* Add the :FROM initarg if it does not yet exist by using the connection’s server’s name.

See SEND

Package

lichat-serverlib

Source

connection-maintenance.lisp (file)

5.1.5 Generic functions

Generic Function: alive-p TIMEOUTABLE

Returns T if the object is still considered to be alive.

Package

lichat-serverlib

Methods

Method: alive-p (TIMEOUTABLE timeoutable)

Source

server-objects.lisp (file)

Generic Function: allowed-content-types OBJECT

Generic Function: (setf allowed-content-types) NEW-VALUE OBJECT

Package

lichat-serverlib

Methods

Method: allowed-content-types (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Method: (setf allowed-content-types) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: backlog OBJECT

Generic Function: (setf backlog) NEW-VALUE OBJECT

Package

lichat-serverlib

Methods

Method: backlog (BACKLOGGED-CHANNEL backlogged-channel)

automatically generated reader method

Source

server-objects.lisp (file)

Method: (setf backlog) NEW-VALUE (BACKLOGGED-CHANNEL backlogged-channel)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: channels OBJECT

Accessor to the hash-table of channels that exist on the server.

See SERVER

Package

lichat-serverlib

Writer

(setf channels) (generic function)

Methods

Method: channels (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf channels) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

channels (generic function)

Methods

Method: (setf channels) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: check-connection-timeout CONNECTION

Package

lichat-serverlib

Methods

Method: check-connection-timeout (CONNECTION connection)

Source

connection-maintenance.lisp (file)

Generic Function: create REGISTRANT NAME SERVER

Creates an appropriate channel object for the registrant on the server.

If NAME is NIL, a random ID with an @ prefix is chosen
that does not already exist on the server.
If NAME is STRING= to the name of the server, a primary
channel is created.
Otherwise a regular channel is created.

This is in accordance to §2.4

Note that this will /not/ check whether a channel of the
given name already exists and will instead just replace
it.

See PREP-PERMS
See LICHAT-PROTOCOL:CREATE
See MAKE-CHANNEL
See FIND-CHANNEL
See LICHAT-PROTOCOL:*DEFAULT-ANONYMOUS-CHANNEL-PERMISSIONS*
See LICHAT-PROTOCOL:*DEFAULT-PRIMARY-CHANNEL-PERMISSIONS*
See LICHAT-PROTOCOL:*DEFAULT-REGULAR-CHANNEL-PERMISSIONS*

Package

lichat-serverlib

Methods

Method: create REGISTRANT NAME (SERVER server)

Source

server-operations.lisp (file)

Generic Function: default-read-limit OBJECT

Generic Function: (setf default-read-limit) NEW-VALUE OBJECT

Package

lichat-serverlib

Methods

Method: default-read-limit (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Method: (setf default-read-limit) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: failure-args CONDITION

The initargs of the failure update that should be constructed to relay this error to the client.

See FAILURE-CONDITION

Package

lichat-serverlib

Methods

Method: failure-args (CONDITION failure-condition)

Source

connection-maintenance.lisp (file)

Generic Function: failure-type CONDITION

The type of the failure update that should be constructed to relay this error to the client.

See FAILURE-CONDITION

Package

lichat-serverlib

Methods

Method: failure-type (CONDITION failure-condition)

Source

connection-maintenance.lisp (file)

Generic Function: find-channel NAME SERVER

Accesses a channel by the given name-ish on the server.

See COERCE-CHANNELNAME
See CHANNELS
See REMOVE-CHANNEL

Package

lichat-serverlib

Writer

(setf find-channel) (generic function)

Methods

Method: find-channel NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: (setf find-channel) CHANNEL NAME SERVER

Package

lichat-serverlib

Reader

find-channel (generic function)

Methods

Method: (setf find-channel) CHANNEL NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: find-profile NAME SERVER

Accesses a profile by the given name-ish on the server.

See COERCE-USERNAME
See PROFILES
See REMOVE-PROFILE

Package

lichat-serverlib

Writer

(setf find-profile) (generic function)

Methods

Method: find-profile NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: (setf find-profile) PROFILE NAME SERVER

Package

lichat-serverlib

Reader

find-profile (generic function)

Methods

Method: (setf find-profile) PROFILE NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: find-user NAME SERVER

Accesses a user by the given name-ish on the server.

See COERCE-USERNAME
See USERS
See REMOVE-USER

Package

lichat-serverlib

Writer

(setf find-user) (generic function)

Methods

Method: find-user NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: (setf find-user) USER NAME SERVER

Package

lichat-serverlib

Reader

find-user (generic function)

Methods

Method: (setf find-user) USER NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: flood-frame OBJECT

Accessor to the number of seconds for which a flood frame lasts.

See FLOOD-PROTECTED-SERVER

Package

lichat-serverlib

Writer

(setf flood-frame) (generic function)

Methods

Method: flood-frame (FLOOD-PROTECTED-SERVER flood-protected-server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf flood-frame) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

flood-frame (generic function)

Methods

Method: (setf flood-frame) NEW-VALUE (FLOOD-PROTECTED-SERVER flood-protected-server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: flood-limit OBJECT

Accessor to the number of updates that can be received within a frame before the connection is limited.

See FLOOD-PROTECTED-SERVER

Package

lichat-serverlib

Writer

(setf flood-limit) (generic function)

Methods

Method: flood-limit (FLOOD-PROTECTED-SERVER flood-protected-server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf flood-limit) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

flood-limit (generic function)

Methods

Method: (setf flood-limit) NEW-VALUE (FLOOD-PROTECTED-SERVER flood-protected-server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: frame-count OBJECT

Accessor to the number of updates that were processed within the last frame.

See FLOOD-PROTECTED-CONNECTION

Package

lichat-serverlib

Writer

(setf frame-count) (generic function)

Methods

Method: frame-count (FLOOD-PROTECTED-CONNECTION flood-protected-connection)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf frame-count) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

frame-count (generic function)

Methods

Method: (setf frame-count) NEW-VALUE (FLOOD-PROTECTED-CONNECTION flood-protected-connection)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: idle-timeout OBJECT

Accessor to the number of seconds a connection can be idle before it is considered timed out.

See SERVER

Package

lichat-serverlib

Writer

(setf idle-timeout) (generic function)

Methods

Method: idle-timeout (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf idle-timeout) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

idle-timeout (generic function)

Methods

Method: (setf idle-timeout) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: init-connection CONNECTION UPDATE

Registers the connection on the server and prepares it for use.

This corresponds to §4.1.8 to §4.1.12 with the additional act that a related profile’s timeout is reset, if such a profile is found.

See RESET-TIMEOUT

Package

lichat-serverlib

Methods

Method: init-connection (CONNECTION connection) UPDATE

Source

server-operations.lisp (file)

Generic Function: join CHANNEL USER &optional ID

Join a user to a channel.

Note that this will /not/ check whether the user is already in the channel or not and will just join them regardless.

A JOIN update is sent to all channel inhabitants, with the given ID, or a fresh one if none is given.

The channel’s timeout is reset.

See LICHAT-PROTOCOL:JOIN
See LICHAT-PROTOCOL:NEXT-ID
See RESET-TIMEOUT

Package

lichat-serverlib

Methods

Method: join (CHANNEL backlogged-channel) (USER user) &optional ID after

Source

server-operations.lisp (file)

Method: join (CHANNEL channel) (USER user) &optional ID

Source

server-operations.lisp (file)

Generic Function: join-times OBJECT

Generic Function: (setf join-times) NEW-VALUE OBJECT

Package

lichat-serverlib

Methods

Method: join-times (BACKLOGGED-CHANNEL backlogged-channel)

automatically generated reader method

Source

server-objects.lisp (file)

Method: (setf join-times) NEW-VALUE (BACKLOGGED-CHANNEL backlogged-channel)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: last-frame OBJECT

Accessor to the last frame number the connection handled.

See FLOOD-PROTECTED-CONNECTION

Package

lichat-serverlib

Writer

(setf last-frame) (generic function)

Methods

Method: last-frame (FLOOD-PROTECTED-CONNECTION flood-protected-connection)

automatically generated reader method

Source

server-objects.lisp (file)

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

Package

lichat-serverlib

Reader

last-frame (generic function)

Methods

Method: (setf last-frame) NEW-VALUE (FLOOD-PROTECTED-CONNECTION flood-protected-connection)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: last-update OBJECT

Accessor to the universal-time of when the last update was processed on the connection.

See CONNECTION

Package

lichat-serverlib

Writer

(setf last-update) (generic function)

Methods

Method: last-update (CONNECTION connection)

automatically generated reader method

Source

server-objects.lisp (file)

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

Package

lichat-serverlib

Reader

last-update (generic function)

Methods

Method: (setf last-update) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: leave CHANNEL USER &key ID NOTIFY-SELF

Leave a user from a channel.

Note that this will /not/ check whether the user actually is in the channel or not and will just leave them regardless.

A LEAVE update is sent to all channel inhabitants, with the given ID, or a fresh one if none is given.

If no users remain, the channel’s timeout is started.

If NOTIFY-SELF is NIL, the LEAVE update is sent to every channel inhabitant other than the user leaving. Otherwise, the update is sent to everyone including the one leaving.

See LICHAT-PROTOCOL:LEAVE
See LICHAT-PROTOCOL:NEXT-ID
See START-TIMEOUT

Package

lichat-serverlib

Methods

Method: leave (CHANNEL backlogged-channel) (USER user) &key ID NOTIFY-SELF after

Source

server-operations.lisp (file)

Method: leave (CHANNEL channel) (USER user) &key ID NOTIFY-SELF

Source

server-operations.lisp (file)

Generic Function: list-channels SERVER

Return a fresh list of all known channel objects for the server.

See CHANNEL

Package

lichat-serverlib

Methods

Method: list-channels (SERVER server)

Source

server-objects.lisp (file)

Generic Function: list-profiles SERVER

Package

lichat-serverlib

Methods

Method: list-profiles (SERVER server)

Source

server-objects.lisp (file)

Generic Function: list-users SERVER

Return a fresh list of all known profile objects for the server.

See PROFILE

Package

lichat-serverlib

Methods

Method: list-users (SERVER server)

Source

server-objects.lisp (file)

Generic Function: make-channel SERVER &rest INITARGS

Construct an appropriate channel object for the server.

See CHANNEL

Package

lichat-serverlib

Methods

Method: make-channel (SERVER server) &rest INITARGS

Source

server-objects.lisp (file)

Generic Function: make-connection SERVER &rest INITARGS

Construct an appropriate connection object for the server.

See CONNECTION

Package

lichat-serverlib

Methods

Method: make-connection (SERVER flood-protected-server) &rest INITARGS

Source

server-objects.lisp (file)

Method: make-connection (SERVER server) &rest INITARGS

Source

server-objects.lisp (file)

Generic Function: make-profile SERVER &rest INITARGS

Construct an appropriate user object for the server.

See PROFILE

Package

lichat-serverlib

Methods

Method: make-profile (SERVER server) &rest INITARGS

Source

server-objects.lisp (file)

Generic Function: make-user SERVER &rest INITARGS

Construct an appropriate user object for the server.

See USER

Package

lichat-serverlib

Methods

Method: make-user (SERVER server) &rest INITARGS

Source

server-objects.lisp (file)

Generic Function: pass-flood-gate CONNECTION UPDATE

Updates flood information for the connection and returns whether the connection is fine or not.

See FLOOD-PROTECTED-CONNECTION
See PROCESS

Package

lichat-serverlib

Methods

Method: pass-flood-gate (CONNECTION flood-protected-connection) (UPDATE update)

Source

connection-maintenance.lisp (file)

Method: pass-flood-gate (CONNECTION connection) UPDATE

Source

connection-maintenance.lisp (file)

Generic Function: process CONNECTION STREAM

Process an update source on a connection.

Sources that are accepted:
* STREAM – An update is read from the stream and sent off to PROCESS again.
* LICHAT-PROTOCOL:UPDATE – The update is handled accordingly.

If an error of type FAILURE-CONDITION is signalled during the evaluation of non-around methods, the encapsulated failure update is sent to the connection. If an error of type LICHAT-PROTOCOL: PROTOCOL-CONDITION is signalled during the evaluation of non-around methods, an update of type LICHAT-PROTOCOL:FAILURE is sent to the connection.

A CONTINUE restart is established around the method that can be used to respond with a generic LICHAT-PROTOCOL:UPDATE-FAILURE and return from the PROCESS method.

This method will also take care to handle flooding and timeout recording for the connection.

The overarching server must establish a restart called CLOSE- CONNECTION around the PROCESS method, or around all calls of it. When this restart is invoked, the server must close the underlying connection.

See LICHAT-PROTOCOL:FROM-WIRE
See LICHAT-PROTOCOL:PROTOCOL-CONDITION
See LICHAT-PROTOCOL:UPDATE-FAILURE
See FAILURE-CONDITION

Package

lichat-serverlib

Methods

Method: process (CONNECTION connection) (UPDATE emotes)

Source

emotes.lisp (file)

Method: process (CONNECTION connection) (UPDATE data)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE backfill)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE user-info)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE register)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE permissions)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE pull)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE kick)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE create)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE users)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE channels)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE leave)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE join)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE message)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE pong)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE ping)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE disconnect)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE connect)

Source

update-handlers.lisp (file)

Method: process (CONNECTION connection) (UPDATE update) around

Source

connection-maintenance.lisp (file)

Method: process (CONNECTION flood-protected-connection) (UPDATE update) around

Source

connection-maintenance.lisp (file)

Method: process (CONNECTION connection) (STREAM stream)

Source

connection-maintenance.lisp (file)

Generic Function: profiles OBJECT

Accessor to the hash-table of profiles that exist on the server.

See SERVER

Package

lichat-serverlib

Writer

(setf profiles) (generic function)

Methods

Method: profiles (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf profiles) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

profiles (generic function)

Methods

Method: (setf profiles) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: read-limit OBJECT

Generic Function: (setf read-limit) NEW-VALUE OBJECT

Package

lichat-serverlib

Methods

Method: read-limit (CONNECTION connection)

automatically generated reader method

Source

server-objects.lisp (file)

Method: (setf read-limit) NEW-VALUE (CONNECTION connection)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: register REGISTRANT PASSWORD SERVER

Register a user profile.

Note that this will /not/ check whether the associated user actually exists on the server or not and will just create the profile regardless.

See FIND-PROFILE
See MAKE-PROFILE
See LICHAT-PROTOCOL:REGISTER

Package

lichat-serverlib

Methods

Method: register REGISTRANT PASSWORD SERVER

Source

server-operations.lisp (file)

Generic Function: remove-channel NAME SERVER

Removes the channel by the given name from the server.

See COERCE-CHANNELNAME
See CHANNELS
See FIND-CHANNEL

Package

lichat-serverlib

Methods

Method: remove-channel NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: remove-profile NAME SERVER

Removes the profile by the given name-ish from the server.

See COERCE-USERNAME
See PROFILES
See FIND-PROFILE

Package

lichat-serverlib

Methods

Method: remove-profile NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: remove-user NAME SERVER

Removes the user by the given name-ish from the server.

See COERCE-USERNAME
See USERS
See FIND-USER

Package

lichat-serverlib

Methods

Method: remove-user NAME (SERVER server)

Source

server-objects.lisp (file)

Generic Function: reset-timeout TIMEOUTABLE

Resets the timeout to never occur.

See TIMEOUTABLE

Package

lichat-serverlib

Methods

Method: reset-timeout (TIMEOUTABLE timeoutable)

Source

server-objects.lisp (file)

Generic Function: salt OBJECT

Accessor to the password hashing salt.

See SERVER

Package

lichat-serverlib

Writer

(setf salt) (generic function)

Methods

Method: salt (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf salt) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

salt (generic function)

Methods

Method: (setf salt) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: send OBJECT CONNECTION

Send an update to a place.

Places that are accepted:
* CONNECTION – Directly sends the update over the wire. Note that the primary method for this must be implemented by the overarching server.
* USER – Relays the update to all connections of the user. * CHANNEL – Relays the update to all users in the channel.

This function has to be called in a regular interval by the overarching server. It will take care of handling connection timeouts and will close the connection in case of one.

See CONNECTION
See USER
See CHANNEL

Package

lichat-serverlib

Methods

Method: send (OBJECT wire-object) (USER user)

Source

connection-maintenance.lisp (file)

Method: send (OBJECT wire-object) (CHANNEL channel)

Source

connection-maintenance.lisp (file)

Method: send (OBJECT update) (CHANNEL backlogged-channel) after

Source

connection-maintenance.lisp (file)

Method: send (OBJECT wire-object) (CONNECTION connection) before

Source

connection-maintenance.lisp (file)

Generic Function: server OBJECT

Accessor to the connection’s server.

See CONNECTION

Package

lichat-serverlib

Writer

(setf server) (generic function)

Methods

Method: server (CONNECTION connection)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf server) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

server (generic function)

Methods

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

automatically generated writer method

Source

server-objects.lisp (file)

Method: (setf server) SERVER (CONNECTION connection) after

Source

server-objects.lisp (file)

Generic Function: start-timeout TIMEOUTABLE

Starts the timeout by setting the object’s TIMEOUT slot to the correct time.

See TIMEOUTABLE
See LICHAT-PROTOCOL:LIFETIME

Package

lichat-serverlib

Methods

Method: start-timeout (TIMEOUTABLE timeoutable)

Source

server-objects.lisp (file)

Generic Function: teardown-connection CONNECTION

Removes and cleans up the connection on the server.

This corresponds to §4.3.3 to §4.3.4 with the additional act that a related profile’s timeout is started, if such a profile is found.

See START-TIMEOUT

Package

lichat-serverlib

Methods

Method: teardown-connection (CONNECTION connection)

Source

server-operations.lisp (file)

Generic Function: timeout OBJECT

The universal-time by which the object will be invalidated, if any.

See TIMEOUTABLE

Package

lichat-serverlib

Writer

(setf timeout) (generic function)

Methods

Method: timeout (TIMEOUTABLE timeoutable)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf timeout) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

timeout (generic function)

Methods

Method: (setf timeout) NEW-VALUE (TIMEOUTABLE timeoutable)

automatically generated writer method

Source

server-objects.lisp (file)

Generic Function: users OBJECT

Accessor to the hash-table of users that exist on the server.

See SERVER

Package

lichat-serverlib

Writer

(setf users) (generic function)

Methods

Method: users (SERVER server)

automatically generated reader method

Source

server-objects.lisp (file)

Generic Function: (setf users) NEW-VALUE OBJECT

Package

lichat-serverlib

Reader

users (generic function)

Methods

Method: (setf users) NEW-VALUE (SERVER server)

automatically generated writer method

Source

server-objects.lisp (file)

5.1.6 Conditions

Condition: failure-condition ()

Wrapper condition to carry a failure update.

See FAILURE-TYPE
See FAILURE-ARGS
See FAIL!

Package

lichat-serverlib

Source

connection-maintenance.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

severe-failure-condition (condition)

Direct methods

• failure-args (method)
• failure-type (method)

Direct slots

Slot: failure-type

Initargs

:type

Readers

failure-type (generic function)

Slot: failure-args

Initargs

:args

Readers

failure-args (generic function)

5.1.7 Classes

Class: backlogged-channel ()

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

channel (class)

Direct methods

• send (method)
• leave (method)
• join (method)
• join-times (method)
• join-times (method)
• backlog (method)
• backlog (method)

Direct slots

Slot: backlog

Initform

(lichat-serverlib::make-ring 100)

Readers

backlog (generic function)

Writers

(setf backlog) (generic function)

Slot: join-times

Initform

(make-hash-table :test (quote eq))

Readers

join-times (generic function)

Writers

(setf join-times) (generic function)

Class: channel ()

A server-side channel object.

See LICHAT-PROTOCOL:CHANNEL See TIMEOUTABLE

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

• timeoutable (class)
• channel (class)

Direct subclasses

backlogged-channel (class)

Direct methods

• send (method)
• leave (method)
• join (method)

Class: connection ()

The representation of a client connection.

See SERVER
See LAST-UPDATE
See LICHAT-PROTOCOL:CONNECTION

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

connection (class)

Direct subclasses

flood-protected-connection (class)

Direct methods

• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• process (method)
• pass-flood-gate (method)
• send (method)
• check-connection-timeout (method)
• teardown-connection (method)
• init-connection (method)
• (setf server) (method)
• initialize-instance (method)
• read-limit (method)
• read-limit (method)
• last-update (method)
• last-update (method)
• server (method)
• server (method)

Direct slots

Slot: server

Initargs

:server

Readers

server (generic function)

Writers

(setf server) (generic function)

Slot: last-update

Initform

(get-universal-time)

Readers

last-update (generic function)

Writers

(setf last-update) (generic function)

Slot: read-limit

Initargs

:read-limit

Readers

read-limit (generic function)

Writers

(setf read-limit) (generic function)

Direct Default Initargs

Initarg	Value
:server	nil

Class: flood-protected-connection ()

A connection with basic time-frame flood-protection.

See CONNECTION
See LAST-FRAME
See FRAME-COUNT

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

connection (class)

Direct methods

• process (method)
• pass-flood-gate (method)
• frame-count (method)
• frame-count (method)
• last-frame (method)
• last-frame (method)

Direct slots

Slot: last-frame

Initform

0

Readers

last-frame (generic function)

Writers

(setf last-frame) (generic function)

Slot: frame-count

Initform

0

Readers

frame-count (generic function)

Writers

(setf frame-count) (generic function)

Class: flood-protected-server ()

A server with basic time-frame flood-protection.

See SERVER
See FLOOD-FRAME
See FLOOD-LIMIT

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

server (class)

Direct methods

• make-connection (method)
• flood-limit (method)
• flood-limit (method)
• flood-frame (method)
• flood-frame (method)

Direct slots

Slot: flood-frame

Initargs

:flood-frame

Readers

flood-frame (generic function)

Writers

(setf flood-frame) (generic function)

Slot: flood-limit

Initargs

:flood-limit

Readers

flood-limit (generic function)

Writers

(setf flood-limit) (generic function)

Direct Default Initargs

Initarg	Value
:flood-frame	30
:flood-limit	40

Class: profile ()

A server-side profile object

See LICHAT-PROTOCOL:PROFILE See TIMEOUTABLE

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

• timeoutable (class)
• profile (class)

Class: server ()

An object representation of the server.

See USER
See USERS
See PROFILES
See CHANNELS
See SALT
See IDLE-TIMEOUT

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

user (class)

Direct subclasses

flood-protected-server (class)

Direct methods

• create (method)
• list-channels (method)
• make-channel (method)
• remove-channel (method)
• find-channel (method)
• find-channel (method)
• list-profiles (method)
• make-profile (method)
• remove-profile (method)
• find-profile (method)
• find-profile (method)
• list-users (method)
• make-user (method)
• remove-user (method)
• find-user (method)
• find-user (method)
• make-connection (method)
• initialize-instance (method)
• default-read-limit (method)
• default-read-limit (method)
• allowed-content-types (method)
• allowed-content-types (method)
• idle-timeout (method)
• idle-timeout (method)
• salt (method)
• salt (method)
• channels (method)
• channels (method)
• profiles (method)
• profiles (method)
• users (method)
• users (method)

Direct slots

Slot: users

Initform

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

Readers

users (generic function)

Writers

(setf users) (generic function)

Slot: profiles

Initform

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

Readers

profiles (generic function)

Writers

(setf profiles) (generic function)

Slot: channels

Initform

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

Readers

channels (generic function)

Writers

(setf channels) (generic function)

Slot: salt

Initargs

:salt

Readers

salt (generic function)

Writers

(setf salt) (generic function)

Slot: idle-timeout

Initargs

:idle-timeout

Readers

idle-timeout (generic function)

Writers

(setf idle-timeout) (generic function)

Slot: allowed-content-types

Initargs

:allowed-content-types

Readers

allowed-content-types (generic function)

Writers

(setf allowed-content-types) (generic function)

Slot: default-read-limit

Initargs

:default-read-limit

Readers

default-read-limit (generic function)

Writers

(setf default-read-limit) (generic function)

Direct Default Initargs

Initarg	Value
:salt	""
:idle-timeout	120
:allowed-content-types	nil
:default-read-limit	nil

Class: timeoutable ()

Superclass for objects that can be invalidated through a timeout.

See TIMEOUT
See START-TIMEOUT
See RESET-TIMEOUT
See ALIVE-P

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• channel (class)
• profile (class)

Direct methods

• alive-p (method)
• reset-timeout (method)
• start-timeout (method)
• timeout (method)
• timeout (method)

Direct slots

Slot: timeout

Initargs

:timeout

Readers

timeout (generic function)

Writers

(setf timeout) (generic function)

Class: user ()

A server-side user object

See LICHAT-PROTOCOL:USER

Package

lichat-serverlib

Source

server-objects.lisp (file)

Direct superclasses

user (class)

Direct subclasses

server (class)

Direct methods

• send (method)
• leave (method)
• leave (method)
• join (method)
• join (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *emotes*

Package

lichat-serverlib

Source

emotes.lisp (file)

5.2.2 Functions

Function: coerce-emote EMOTE

Package

lichat-serverlib

Source

emotes.lisp (file)

Function: coerce-emote-data DATA

Package

lichat-serverlib

Source

emotes.lisp (file)

Function: fail!! TYPE-ISH &rest INITARGS

Package

lichat-serverlib

Source

connection-maintenance.lisp (file)

Function: make-ring SIZE

Package

lichat-serverlib

Source

server-objects.lisp (file)

5.2.3 Conditions

Condition: severe-failure-condition ()

Package

lichat-serverlib

Source

connection-maintenance.lisp (file)

Direct superclasses

failure-condition (condition)

Appendix A Indexes

A.1 Concepts

A.2 Functions