-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.txt
84 lines (58 loc) · 3.54 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
===============================================================================
FACILSERVIL : `Easy Server`
===============================================================================
Sometimes, it's just annoying and time-draining to deal with all of the
intricacies of :usockets— facilservil abstracts away all of those bits.
————————————————————————————————————————
FEATURES
————————————————————————————————————————
* Multi-threaded
* Input-handling
* Logging system
* UTF-8
————————————————————————————————————————
DEMONSTRATION
————————————————————————————————————————
Load up Facilservil, then run this in your repl:
(facilservil:ex-server "localhost" 8888)
Now, connect your computer on port 8888.
This example server is a chat server, so it might be useful to connect a couple
of times, for demonstration's sake.
If you're on LiGNUx or BSD, you can use "telnet localhost 8888"
In reality, 'ex-server is just a small function for demonstration-- the
example server really looks like this:
(facilservil:server host port
#'ex-connect #'ex-disconnect #'ex-input #'ex-loop)
It runs #'ex-connect when you connect, #'ex-disconnect when you disconnect,
and #'ex-input-ex after you finish a command, and #'ex-loop after handling
everyone's input (or after timeout of waiting for input).
For a different kind of example (less interesting, since it takes no user
input), look at QOTDD (https://hak.xwx.moe/jadedctrl/qotdd).
For a more comprehensive guide to Facilservil, look to USAGE, coming right up.
————————————————————————————————————————
USAGE
————————————————————————————————————————
To use Facilservil, just use the `facilservil:server` function somewhere.
"host" and "port" are, obviously, the host-IP and port, respectively.
"on-connect" is the function that will be executed when a user connects.
"on-disconnect" is the function that will run when someone disconnects.
"on-input" is the function that will run when someone sends a command
"on-loop" is the function running when all input is complete/timeouts
Basically, you write the "connecting", "disconnecting", and "input-handler"
functions (maybe "halting"), and you've got a handy-dandy server.
These functions you write must accept the following arguments:
on-connect (connection connection-list)
on-disconnect (connection connection-list)
on-input (connection input-string connection-list)
on-loop (connection-list)
You can use #'send to send strings to a given connection.
Each connection has a built-in hashtable (for storing user-IDs, usernames,
whatever you need). You can store/set a variable with #'bury, and retrieve with
#'dig.
————————————————————————————————————————
BORING STUFF
————————————————————————————————————————
Based on Sergey's gist <[email protected]>
Author is Jaidyn Ann <[email protected]>
License is BSD 3-Clause “New”, see COPYING.txt
Sauce is at https://hak.xwx.moe/jadedctrl/facilservil