Maiden-Lichat

About

This is a client that enables using Maiden as a client for Lichat networks.

How To

In order to use this client, simply create an instance of lichat-client, add it to a core, and start it. You can use add-to-core to do so quickly. Upon construction, you will probably be interested in the following initargs:

:username The name to use on the server. The client's name defaults to the hostname. If you need to retrieve it from the core easily, or want to maintain multiple connections to the same host, you should also provide :name.
:password The password for use upon connection. Defaults to NIL. If your user has an account, you will need to set this to be able to connect.
:host The hostname of the server to connect to.
:port The port of the server to connect to. Defaults to 1111.

All the Lichat replies and commands are present as events, and functions for the latter, in the org.shirakumo.maiden.clients.lichat.rpl and org.shirakumo.maiden.clients.lichat.cmd packages, which are nicknamed to lichat-rpl and lichat-cmd respectively.

Copyright

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

Package Index

MAIDEN-LICHAT (ORG.SHIRAKUMO.MAIDEN.CLIENTS.LICHAT)

class

`LICHAT-CHANNEL`

Class to represent a channel on the Lichat server.

See MAIDEN-CLIENT-ENTITIES:SIMPLE-CHANNEL

class

`LICHAT-CLIENT`

This client offers a connection to a Lichat server.

The client will attempt to keep a properly consistent
view of the server. It will track all users and channels
and their relationships to the best of its ability.
It will also attempt to automatically reconnect.

See MAIDEN-NETWORKING:TEXT-TCP-CLIENT
See MAIDEN-NETWORKING:RECONNECTING-CLIENT
See MAIDEN-NETWORKING:TIMEOUT-CLIENT
See MAIDEN-CLIENT-ENTITIES:SIMPLE-USER-CHANNEL-CLIENT
See SERVERNAME
See MAIDEN-CLIENT-ENTITIES:USERNAME
See PASSWORD

class

`LICHAT-USER`

Class to represent a user on the Lichat server.

See MAIDEN-CLIENT-ENTITIES:SIMPLE-USER

accessor (

`PASSWORD`

OBJECT)

Accessor to the password used to connect to the server with.

See LICHAT-CLIENT

accessor (

`USERNAME`

USER)

Accessor to the entity's name on the client network.

This may or may not be distinct from the entity's NAME.
Especially clients may often want to keep a separate NAME
and USERNAME, as the name should stay the same on the local
core, but the username may possibly change or be different
depending on the network.

See USER
See USER-CLIENT