Lichat-Ws-Server

About Lichat-WS-Server

This is a simple, threaded, WebSocket-based server for the Lichat protocol.

How To

Create a new server instance and pass it whatever settings you would like.

(defvar *server* (make-instance 'lichat-ws-server:server))

Notable initargs of potential interest are:

:name The name the server goes by on its own network. Defaults to (machine-instance).
:hostname The hostname to which the TCP listener should bind. The default is 0.0.0.0.
:port The port the TCP listener should listen on. The default is 1111.
:ping-interval The interval in which pings should be sent out to clients. The default is 60.
:salt The salt with which passwords are hashed. The default is an empty string.
:idle-timeout The number of seconds without a response from a client after which it is considered to have timed out. The default is 120.
:flood-frame The size of a flood prevention frame. The default is 30.
:flood-limit The number of allowed updates within a frame before flood limitation takes effect. The default is 40.
:connection-limit The number of connections in total that the server supports before dropping incoming ones. The default is 100.

Once a server exists, it can be started to listen to incoming connections:

(lichat-ws-server:open-connection *server*)

The server logs information via Verbose. If you set the REPL level to :trace you should see a bunch of status messages being printed every now and again.

Once you're done with the server, you can shut it down again.

(lichat-ws-server:close-connection *server*)

Also See

lichat-protocol The Lichat protocol specification.
lichat-serverlib An agnostic implementation of the server-side protocol.
lichat-tcp-server A basic, threaded, TCP-based implementation of a Lichat server.

Copyright

lichat-ws-server is licensed under the Artistic license. © Nicolas Hafner <shinmera@tymoon.eu> . This library can be obtained on https://github.com/Shirakumo/lichat-ws-server.

Package Index

LICHAT-WS-SERVER (ORG.SHIRAKUMO.LICHAT.WS-SERVER)

special

`DEFAULT-PORT`

The standard port on which the server will run.

Should be 1113.

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

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

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

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

accessor (
CONNECTION-LIMIT
OBJECT)
```
 
```

accessor (

`CONNECTIONS`

OBJECT)

Accessor to the list of connections on the server.

See SERVER
See CONNECTION

accessor (

`HOSTNAME`

OBJECT)

Accessor to the hostname of the object.

See SERVER

accessor (

`LOCK`

OBJECT)

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

See SERVER 
See CONNECTION
See USER
See CHANNEL

accessor (

`PING-INTERVAL`

OBJECT)

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

See SERVER

accessor (

`PORT`

OBJECT)

Accessor to the port of the object.

See SERVER
See *DEFAULT-PORT*

accessor (

`STATUS`

OBJECT)

Accessor to the status of the connection.

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

See CONNECTION

accessor (

`THREAD`

OBJECT)

Accessor to the background ping thread of the server.

See SERVER

generic (

`CLOSE-CONNECTION`

SERVER)

Stop accepting incoming connections and close all existing ones.

See CONNECTIONS
See THREAD
See SERVER

generic (

`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

generic (

`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