The lichat-ws-server Reference Manual

3.1.1 lichat-ws-server/lichat-ws-server.asd

Source

lichat-ws-server.asd.

Parent Component

lichat-ws-server (system).

ASDF Systems

lichat-ws-server.

---

3.1.2 lichat-ws-server/package.lisp

Source

lichat-ws-server.asd.

Parent Component

lichat-ws-server (system).

Packages

lichat-ws-server.

---

3.1.3 lichat-ws-server/server.lisp

Dependency

package.lisp (file).

Source

lichat-ws-server.asd.

Parent Component

lichat-ws-server (system).

Public Interface

• *default-port* (special variable).
• channel (class).
• check-message (method).
• client-connected (method).
• client-disconnected (method).
• close-connection (method).
• connection (class).
• connection-limit (reader method).
• (setf connection-limit) (writer method).
• connections (reader method).
• (setf connections) (writer method).
• handle-pings (method).
• hostname (reader method).
• (setf hostname) (writer method).
• init-connection (method).
• lock (reader method).
• lock (reader method).
• lock (reader method).
• lock (reader method).
• (setf lock) (writer method).
• (setf lock) (writer method).
• (setf lock) (writer method).
• (setf lock) (writer method).
• make-channel (method).
• make-connection (method).
• make-user (method).
• open-connection (method).
• ping-interval (reader method).
• (setf ping-interval) (writer method).
• port (reader method).
• (setf port) (writer method).
• process (method).
• process (method).
• send (method).
• send (method).
• server (class).
• status (reader method).
• (setf status) (writer method).
• teardown-connection (method).
• teardown-connection (method).
• text-message-received (method).
• thread (reader method).
• (setf thread) (writer method).
• user (class).

Internals

• *servers* (special variable).
• acceptor (reader method).
• (setf acceptor) (writer method).
• dispatch-server (function).

---

3.1.4 lichat-ws-server/documentation.lisp

Dependency

server.lisp (file).

Source

lichat-ws-server.asd.

Parent Component

lichat-ws-server (system).

---

5.1.1 Special variables

Special Variable: *default-port* ¶

The standard port on which the server will run.

Should be 1113.

Package

lichat-ws-server.

Source

server.lisp.

---

5.1.2 Generic functions

Generic Function: close-connection (server) ¶

Stop accepting incoming connections and close all existing ones.

See CONNECTIONS
See THREAD
See SERVER

Package

lichat-ws-server.

Methods

Method: close-connection ((server server)) ¶

Source

server.lisp.

Generic Reader: connection-limit (object) ¶

Package

lichat-ws-server.

Methods

Reader Method: connection-limit ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

connection-limit.

Generic Writer: (setf connection-limit) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf connection-limit) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

connection-limit.

Generic Reader: connections (object) ¶

Accessor to the list of connections on the server.

See SERVER
See CONNECTION

Package

lichat-ws-server.

Methods

Reader Method: connections ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

connections.

Generic Writer: (setf connections) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf connections) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

connections.

Generic Function: handle-pings (server) ¶

This function will loop on the server and send ping requests in a regular interval to clients that have not replied in a while.

During the processing a restart called STOP-HANDLING
is active that, when invoked, exits the function.

See PING-INTERVAL
See SERVER

Package

lichat-ws-server.

Methods

Method: handle-pings ((server server)) ¶

Source

server.lisp.

Generic Reader: hostname (object) ¶

Accessor to the hostname of the object.

See SERVER

Package

lichat-ws-server.

Methods

Reader Method: hostname ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

hostname.

Generic Writer: (setf hostname) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf hostname) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

hostname.

Generic Reader: lock (object) ¶

Accessor to the lock of the object that is used to mutually exclude access.

See SERVER
See CONNECTION
See USER
See CHANNEL

Package

lichat-ws-server.

Methods

Reader Method: lock ((user user)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

lock.

Reader Method: lock ((channel channel)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

lock.

Reader Method: lock ((connection connection)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

lock.

Reader Method: lock ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

lock.

Generic Writer: (setf lock) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf lock) ((user user)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

lock.

Writer Method: (setf lock) ((channel channel)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

lock.

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

automatically generated writer method

Source

server.lisp.

Target Slot

lock.

Writer Method: (setf lock) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

lock.

Generic Function: open-connection (server) ¶

Start accepting incoming connections on the server.

This will launch a background thread which will call HANDLE-PINGS on the server. It will also construct and start the Hunchentoot acceptor of the server.

See HANDLE-PINGS
See THREAD
See ACCEPTOR
See SERVER

Package

lichat-ws-server.

Methods

Method: open-connection ((server server)) ¶

Source

server.lisp.

Generic Reader: ping-interval (object) ¶

Accessor to the amount of seconds to wait for an update before sending a PING.

See SERVER

Package

lichat-ws-server.

Methods

Reader Method: ping-interval ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

ping-interval.

Generic Writer: (setf ping-interval) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf ping-interval) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

ping-interval.

Generic Reader: port (object) ¶

Accessor to the port of the object.

See SERVER
See *DEFAULT-PORT*

Package

lichat-ws-server.

Methods

Reader Method: port ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

port.

Generic Writer: (setf port) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf port) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

port.

Generic Reader: status (object) ¶

Accessor to the status of the connection.

The value should be one of :STARTING :RUNNING :STOPPING

See CONNECTION

Package

lichat-ws-server.

Methods

Reader Method: status ((connection connection)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

status.

Generic Writer: (setf status) (object) ¶

Package

lichat-ws-server.

Methods

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

automatically generated writer method

Source

server.lisp.

Target Slot

status.

Generic Reader: thread (object) ¶

Accessor to the background ping thread of the server.

See SERVER

Package

lichat-ws-server.

Methods

Reader Method: thread ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

thread.

Generic Writer: (setf thread) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf thread) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

thread.

---

5.1.3 Standalone methods

Method: check-message ((resource websocket-resource) (connection connection) opcode length total) ¶

Package

hunchensocket.

Source

server.lisp.

Method: client-connected ((server server) (connection connection)) ¶

Package

hunchensocket.

Source

server.lisp.

Method: client-disconnected ((server server) (connection connection)) ¶

Package

hunchensocket.

Source

server.lisp.

Method: init-connection :around ((connection connection) update) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: make-channel ((server server) &rest initargs) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: make-connection ((server server) &rest initargs) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: make-user ((server server) &rest initargs) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: process :around ((connection connection) (update create)) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: process :around ((connection connection) (update register)) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: send :around ((object object) (channel channel)) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: send ((object object) (connection connection)) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: teardown-connection :around ((connection connection)) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: teardown-connection :after ((connection connection)) ¶

Package

lichat-serverlib.

Source

server.lisp.

Method: text-message-received ((server server) (connection connection) message) ¶

Package

hunchensocket.

Source

server.lisp.

---

5.1.4 Classes

Class: channel ¶

Channel class.

Access to the channel is properly handled for
mutual exclusion from threads by its LOCK. Particularly, the following methods are mutually excluded via this lock:

LICHAT-SERVERLIB:JOIN
LICHAT-SERVERLIB:LEAVE

See LICHAT-SERVERLIB:CHANNEL
See LOCK

Package

lichat-ws-server.

Source

server.lisp.

Direct superclasses

backlogged-channel.

Direct methods

• (setf lock).
• lock.
• send.

Direct slots

Slot: lock ¶

Initform

(bordeaux-threads:make-recursive-lock)

Readers

lock.

Writers

(setf lock).

Class: connection ¶

Connection class. Each connection to a client will have an instance of this class.

Access to the connection is properly handled for
mutual exclusion from threads by its LOCK. Particularly,
the following methods are mutually excluded via this lock:

LICHAT-SERVERLIB:SEND

See LICHAT-SERVERLIB:FLOOD-PROTECTED-CONNECTION
See HUNCHENSOCKET:WEBSOCKET-CLIENT
See STATUS
See LOCK

Package

lichat-ws-server.

Source

server.lisp.

Direct superclasses

• flood-protected-connection.
• websocket-client.

Direct methods

• check-message.
• client-connected.
• client-disconnected.
• init-connection.
• (setf lock).
• lock.
• process.
• process.
• send.
• (setf status).
• status.
• teardown-connection.
• teardown-connection.
• text-message-received.

Direct Default Initargs

Initarg	Value
:user	nil

Direct slots

Slot: lock ¶

Initform

(bordeaux-threads:make-recursive-lock)

Readers

lock.

Writers

(setf lock).

Slot: status ¶

Initform

:starting

Readers

status.

Writers

(setf status).

Class: server ¶

Server class. You should instantiate this.

Access to the server is properly handled for
mutual exclusion from threads by its LOCK. Particularly, the following updates and processing methods for updates are mutually excluded via this lock:

LICHAT-SERVERLIB:TEARDOWN-CONNECTION LICHAT-PROTOCOL:CONNECT
LICHAT-PROTOCOL:REGISTER
LICHAT-PROTOCOL:CREATE

See LICHAT-SERVERLIB:FLOOD-PROTECTED-SERVER
See HUNCHENSOCKET:WEBSOCKET-RESOURCE
See HOSTNAME
See PORT
See ACCEPTOR
See THREAD
See PING-INTERVAL
See LOCK
See CONNECTIONS

Package

lichat-ws-server.

Source

server.lisp.

Direct superclasses

• flood-protected-server.
• websocket-resource.

Direct methods

• (setf acceptor).
• acceptor.
• client-connected.
• client-disconnected.
• close-connection.
• (setf connection-limit).
• connection-limit.
• (setf connections).
• connections.
• handle-pings.
• (setf hostname).
• hostname.
• (setf lock).
• lock.
• make-channel.
• make-connection.
• make-user.
• open-connection.
• (setf ping-interval).
• ping-interval.
• (setf port).
• port.
• text-message-received.
• (setf thread).
• thread.

Direct Default Initargs

Initarg	Value
:name	(machine-instance)
:hostname	localhost
:port	*default-port*
:ping-interval	10
:connection-limit	100
:client-class	(quote connection)

Direct slots

Slot: hostname ¶

Initargs

:hostname

Readers

hostname.

Writers

(setf hostname).

Slot: port ¶

Initargs

:port

Readers

port.

Writers

(setf port).

Slot: acceptor ¶

Readers

acceptor.

Writers

(setf acceptor).

Slot: thread ¶

Readers

thread.

Writers

(setf thread).

Slot: ping-interval ¶

Initargs

:ping-interval

Readers

ping-interval.

Writers

(setf ping-interval).

Slot: lock ¶

Initform

(bordeaux-threads:make-recursive-lock)

Readers

lock.

Writers

(setf lock).

Slot: connections ¶

Readers

connections.

Writers

(setf connections).

Slot: connection-limit ¶

Initargs

:connection-limit

Readers

connection-limit.

Writers

(setf connection-limit).

Class: user ¶

User class.

Access to the user is properly handled for
mutual exclusion from threads by its LOCK. Particularly, the following methods are mutually excluded via this lock:

LICHAT-SERVERLIB:JOIN
LICHAT-SERVERLIB:LEAVE

See LICHAT-SERVERLIB:USER
See LOCK

Package

lichat-ws-server.

Source

server.lisp.

Direct superclasses

user.

Direct methods

• (setf lock).
• lock.

Direct slots

Slot: lock ¶

Initform

(bordeaux-threads:make-recursive-lock)

Readers

lock.

Writers

(setf lock).

---

5.2.1 Special variables

Special Variable: *servers* ¶

Package

lichat-ws-server.

Source

server.lisp.

---

5.2.2 Ordinary functions

Function: dispatch-server (request) ¶

Package

lichat-ws-server.

Source

server.lisp.

---

5.2.3 Generic functions

Generic Reader: acceptor (object) ¶

Accessor to the Hunchentoot acceptor of the server.

See SERVER

Package

lichat-ws-server.

Methods

Reader Method: acceptor ((server server)) ¶

automatically generated reader method

Source

server.lisp.

Target Slot

acceptor.

Generic Writer: (setf acceptor) (object) ¶

Package

lichat-ws-server.

Methods

Writer Method: (setf acceptor) ((server server)) ¶

automatically generated writer method

Source

server.lisp.

Target Slot

acceptor.

---