Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the trivial-ws Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:42:47 2018 GMT+0.
| • Introduction: | What trivial-ws is all about | |
| • Systems: | The systems documentation | |
| • Modules: | The modules documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Trivial WebSockets, built on top of Hunchensocket for the server and websocket-driver for the client.
Here's a simple echo server:
(defvar *server*
(trivial-ws:make-server
:on-connect #'(lambda (server)
(format t "Connected~%"))
:on-disconnect #'(lambda (server)
(format t "Disconnected~%"))
:on-message #'(lambda (server message)
(format t "Received: ~A~%" message)
(trivial-ws:send (first (trivial-ws:clients server))
message))))
Then start it:
(defvar *handler* (trivial-ws:start *server* 4040))
Then go to http://www.websocket.org/echo.html and change the server to
ws://localhost:4040/ and try it out.
You can stop it with (trivial-ws:stop *handler*).
Inside the callbacks you can use two functions: (trivial-ws:clients server)
will return the list of connected clients, and (trivial-ws:send client "string") will send a message to a selected client.
Copyright (c) 2016 Fernando Borretti
Licensed under the MIT License.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The trivial-ws system: |
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(:git "git@github.com:ceramic/trivial-ws.git")
MIT
Trivial WebSockets.
# trivial-ws
Trivial WebSockets, built on top of [Hunchensocket][hs] for the server and
[websocket-driver][driver] for the client.
# Usage
Here’s a simple echo server:
~~~lisp
(defvar *server*
(trivial-ws:make-server
:on-connect #’(lambda (server)
(format t "Connected~%"))
:on-disconnect #’(lambda (server)
(format t "Disconnected~%"))
:on-message #’(lambda (server message)
(format t "Received: ~A~%" message)
(trivial-ws:send (first (trivial-ws:clients server))
message))))
~~~
Then start it:
~~~lisp
(defvar *handler* (trivial-ws:start *server* 4040))
~~~
Then go to http://www.websocket.org/echo.html and change the server to
‘ws://localhost:4040/‘ and try it out.
You can stop it with ‘(trivial-ws:stop *handler*)‘.
Inside the callbacks you can use two functions: ‘(trivial-ws:clients server)‘
will return the list of connected clients, and ‘(trivial-ws:send client
"string")‘ will send a message to a selected client.
# License
Copyright (c) 2016 Fernando Borretti
Licensed under the MIT License.
[hs]: https://github.com/capitaomorte/hunchensocket
[driver]: https://github.com/fukamachi/websocket-driver
0.1
hunchensocket
trivial-ws.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
| • The trivial-ws/src module: |
trivial-ws (system)
src/
server.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The trivial-ws.asd file: | ||
| • The trivial-ws/src/server.lisp file: |
Next: The trivial-ws/src/server<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
trivial-ws.asd
trivial-ws (system)
Previous: The trivial-ws<dot>asd file, Up: Lisp files [Contents][Index]
src (module)
src/server.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The trivial-ws package: |
Trivial WebSockets.
server.lisp (file)
common-lisp
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: | ||
| • Exported classes: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
server.lisp (file)
server.lisp (file)
Next: Exported classes, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Return a list of server clients.
server.lisp (file)
Create a server given the three callback functions.
server.lisp (file)
Send a string of text to the client.
server.lisp (file)
Start the server. Returns a handler object.
server.lisp (file)
Stops a server handler.
server.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
server.lisp (file)
websocket-resource (class)
The function that is called when a client connects.
function
:on-connect
(function (lambda (trivial-ws:server) (declare (ignore trivial-ws:server)) nil))
on-connect (generic function)
The function that is called when a client disconnects.
function
:on-disconnect
(function (lambda (trivial-ws:server) (declare (ignore trivial-ws:server)) nil))
on-disconnect (generic function)
The function that’s called when a client sends a message.
function
:on-message
(function (lambda (trivial-ws:server trivial-ws::message) (declare (ignore trivial-ws:server trivial-ws::message)) nil))
on-message (generic function)
| Initarg | Value |
|---|---|
| :client-class | (quote trivial-ws::client) |
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal generic functions: | ||
| • Internal classes: |
Next: Internal classes, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
automatically generated reader method
server.lisp (file)
The function that is called when a client connects.
server.lisp (file)
The function that is called when a client disconnects.
server.lisp (file)
The function that’s called when a client sends a message.
server.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
server.lisp (file)
websocket-client (class)
name (method)
:user-agent
name (generic 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 M T |
|---|
| Jump to: | F L M T |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | C F G M N O S |
|---|
| Jump to: | C F G M N O S |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | +
N O S |
|---|
| Jump to: | +
N O S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C P S T |
|---|
| Jump to: | C P S T |
|---|