Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the lisp-chat Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:05:54 2018 GMT+0.
| • Introduction: | What lisp-chat 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 |
An experimental chat irc-like written in Lisp.
You'll need in your system:
Make sure that ~/.sbclrc has a entry calling to the Quicklisp setup.
(load "~/.quicklisp/setup.lisp")
Since that ~/.quicklisp is the Quicklisp instalation distribution, clone this
repository with:
git clone https://www.github.com/ryukinix/lisp-chat.git ~/.quicklisp/local-projects/lisp-chat
As I said, we'll need a proper instalation of Quicklisp to getting this running. To accomplish that,
if you are not familiar with the CL ecossystem, I'll guide you in a simple way: clone the Quicklisp Client and execute the setup.lisp with sbcl --script setup.lisp.
In general Quicklisp distribution provide the folder ~/quicklisp instead
of ~/.quicklisp, but I personally don't like it much. Make sure to synchronize with the quicklisp correct folder. Maybe
will need change the .sblcrc file to accomplish that, since for default as I said quicklisp set ~/quicklisp folder.
Load the server
$ ./lisp-chat-server
Get a client
$ ./lisp-chat
You can easilly setup your own configuration of *port* and
*domain* for running a new instance of the server and client. For
now we have a instance of lisp-chat as example running. If you really
want to runs locally, you can just change the *domain* variable to "localhost" as:
(require 'lisp-chat)
(setq lisp-chat-config:*domain* "localhost")
If you want test this and don't have the Lisp environment with SBCL and Quicklisp, I have two alternative choices for you:
On Python client, I wrote in a way only using ths stdlib avoiding pain to handle the dependency hell, so you can just call that:
$ python client.py
So finally... netcat. Yes! You can even just use netcat! An user called Chris in past days
just logged in the server with the following message:
|16:30:37| [Chris]: Used netcad
|16:30:41| [Chris]: netcat*
|16:30:50| [Chris]: bye
So you can type netcat chat.lerax.me 5558 and go on! I tested on my machine and
works fine! The main reason is because the communication between
server and client just use raw data. For better synchronization with
text data from server while you typing, I suggest you to
use a readline wrapper like rlwrap calling as rlwrap netcat ryukinix.tk 5558.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The lisp-chat system: |
Manoel Vilela
MIT
An experimental chat irc-like
0.1
lisp-chat.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The lisp-chat.asd file: | ||
| • The lisp-chat/src/config.lisp file: | ||
| • The lisp-chat/src/client.lisp file: | ||
| • The lisp-chat/src/server.lisp file: |
Next: The lisp-chat/src/config<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
lisp-chat.asd
lisp-chat (system)
Next: The lisp-chat/src/client<dot>lisp file, Previous: The lisp-chat<dot>asd file, Up: Lisp files [Contents][Index]
lisp-chat (system)
src/config.lisp
Next: The lisp-chat/src/server<dot>lisp file, Previous: The lisp-chat/src/config<dot>lisp file, Up: Lisp files [Contents][Index]
src/config.lisp (file)
lisp-chat (system)
src/client.lisp
main (function)
Previous: The lisp-chat/src/client<dot>lisp file, Up: Lisp files [Contents][Index]
src/config.lisp (file)
lisp-chat (system)
src/server.lisp
main (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The lisp-chat-config package: | ||
| • The lisp-chat-client package: | ||
| • The lisp-chat-server package: |
Next: The lisp-chat-client package, Previous: Packages, Up: Packages [Contents][Index]
src/config.lisp (file)
common-lisp
Next: The lisp-chat-server package, Previous: The lisp-chat-config package, Up: Packages [Contents][Index]
src/client.lisp (file)
main (function)
Previous: The lisp-chat-client package, Up: Packages [Contents][Index]
src/server.lisp (file)
main (function)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables: | ||
| • Exported functions: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
src/config.lisp (file)
src/config.lisp (file)
src/config.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
src/client.lisp (file)
Well, this function run all the necessary shits.
src/server.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal functions: | ||
| • Internal structures: |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/client.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
Next: Internal structures, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Show a list of the available commands of lisp-chat
src/server.lisp (file)
Show the last messages typed on the server.
DEPTH is optional number of messages frames from log
src/server.lisp (file)
Return a string nice encoded to preset the uptime since the server started.
src/server.lisp (file)
Return a list separated by commas of the currently logged users
src/server.lisp (file)
Wow, this is a horrible hack to get a string as symbol for functions/command like /help /users /log and so on.
src/server.lisp (file)
src/server.lisp (file)
Delete a CLIENT from the list *clients*
src/server.lisp (file)
src/client.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
This procedure is a wrapper for CLIENT-READER-ROUTINE treating all the possible errors based on HANDLER-CASE macro.
src/server.lisp (file)
This function create a IO-bound procedure to act
by reading the events of a specific CLIENT.
On this software each client talks on your own thread.
src/server.lisp (file)
src/client.lisp (file)
src/server.lisp (file)
Select the stream IO from the client
src/server.lisp (file)
This function prepare the CONTENT as a message by the @server
src/server.lisp (file)
This is a special thread just for accepting connections from SOCKET-SERVER and creating new clients from it.
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
This procedure create a new client based on CONNECTION made by USOCKET:SOCKET-ACCEPT. This shit create a lot of side effects as messages if the debug is on because this makes all the log stuff to make analysis
src/server.lisp (file)
If *debug* from lisp-chat-config is true, print debug info on running based on ARGS
src/server.lisp (file)
src/client.lisp (file)
The default message format of this server. MESSAGE is a string Changing this reflects all the layout from client/server. Probably this would be the MFRP: Manoel Fucking Raw Protocol. Because this we can still use netcat as client for lisp-chat.
src/server.lisp (file)
Return a encoded string as HH:MM:SS based on the current timestamp.
src/server.lisp (file)
src/client.lisp (file)
src/client.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
This procedure is a general independent thread to run brodcasting all the clients when a message is ping on this server
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
src/server.lisp (file)
Push a messaged FROM as CONTENT into the *messages-stack*
src/server.lisp (file)
src/client.lisp (file)
This function is a wrapper for CREATE-CLIENT treating the exceptions.
src/server.lisp (file)
src/client.lisp (file)
Send to CLIENT a MESSAGE :type string
src/server.lisp (file)
src/client.lisp (file)
src/client.lisp (file)
This is the general server-loop procedure. Create the threads
necessary for the basic working state of this chat. The main idea
is creating a MESSAGE-BROADCAST procedure and CONNECTION-HANDLER
procedure running as separated threads.
The first procedure send always a new message too all clients defined on *clients* when *messages-semaphore* is signalized. The second procedure is a general connection-handler for new clients trying connecting to the server.
src/server.lisp (file)
Given a USOCKET:SOCKET instance return a ipv4 encoded IP string
src/server.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
This structure handle the creation/control of the clients of the server. NAME is a string. Socket is a USOCKET:SOCKET and address is a ipv4 encoded string.
src/server.lisp (file)
structure-object (structure)
client-name (function)
(setf client-name) (function)
client-socket (function)
(setf client-socket) (function)
client-address (function)
(setf client-address) (function)
This structure abstract the type message with is saved into *messages-log* and until consumed, temporally pushed to *messages-stack*. FROM, CONTENT and TIME has type string
src/server.lisp (file)
structure-object (structure)
message-from (function)
(setf message-from) (function)
message-content (function)
(setf message-content) (function)
message-time (function)
(setf message-time) (function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L |
|---|
| Jump to: | F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
/
C D E F G L M P R S |
|---|
| Jump to: | (
/
C D E F G L M P R S |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
A C F N S T |
|---|
| Jump to: | *
A C F N S T |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C L M P S |
|---|
| Jump to: | C L M P S |
|---|