This is the 40ants-slynk Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:10:49 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
40ants-slynkUtilities to start SLYNK if needed and to track active connections.
Alexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/slynk)
Unlicense
<a id="x-2840ANTS-SLYNK-DOCS-2FINDEX-3A-40README-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
# 40ants-slynk - Utilities to start SLYNK if needed and to track active connections.
<a id="40-ants-slynk-asdf-system-details"></a>
## 40ANTS-SLYNK ASDF System Details
* Description: Utilities to start ‘SLYNK‘ if needed and to track active connections.
* Licence: Unlicense
* Author: Alexander Artemenko <svetlyak.40wt@gmail.com>
* Homepage: [https://40ants.com/slynk/][fe84]
* Bug tracker: [https://github.com/40ants/slynk/issues][f5e4]
* Source control: [GIT][1ed5]
* Depends on: [40ants-logging][422a], [global-vars][07be], [log4cl][7f8b], [slynk][b440], [slynk-macrostep][e044], [slynk-named-readtables][433f]
[][e83d]
<a id="x-2840ANTS-SLYNK-DOCS-2FINDEX-3A-3A-40INSTALLATION-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Installation
You can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:
“‘
(ql-dist:install-dist "http://dist.ultralisp.org/"
:prompt nil)
(ql:quickload :40ants-slynk)
“‘
<a id="x-2840ANTS-SLYNK-DOCS-2FINDEX-3A-3A-40USAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## Usage
This library provides a little helper, used in ‘40A‘nts webservices.
it does two things:
* Starts Slynk server in there is ‘SLYNK‘_‘PORT‘ env variable.
* Setup logging for connected Slynk connection. It uses [‘40ants-logging‘][970f] system for configuration.
<a id="x-2840ANTS-SLYNK-DOCS-2FINDEX-3A-3A-40API-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>
## API
<a id="x-2840ANTS-SLYNK-3A-2ACONNECTIONS-2A-20-28VARIABLE-29-29"></a>
### [variable](9cbd) ‘40ants-slynk:*connections*‘ nil
Here we’ll store all Slynk connections.
<a id="x-2840ANTS-SLYNK-3ASTART-SLYNK-IF-NEEDED-20FUNCTION-29"></a>
### [function](0e2b) ‘40ants-slynk:start-slynk-if-needed‘
Use this function before starting the backend server.
If ‘SLYNK‘_‘PORT‘ environment variable is set, then this function
will create a Slynk server on that port and localhost interface.
To change an interface, set ‘SLYNK‘_‘INTERFACE‘ environment variable.
[970f]: https://40ants.com/logging/#x-28-23A-28-2814-29-20BASE-CHAR-20-2E-20-2240ants-logging-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29
[fe84]: https://40ants.com/slynk/
[1ed5]: https://github.com/40ants/slynk
[e83d]: https://github.com/40ants/slynk/actions
[9cbd]: https://github.com/40ants/slynk/blob/856ea1acdfba75e0c8523c7426f6aa4a354e199f/src/core.lisp#L23
[0e2b]: https://github.com/40ants/slynk/blob/856ea1acdfba75e0c8523c7426f6aa4a354e199f/src/core.lisp#L63
[f5e4]: https://github.com/40ants/slynk/issues
[422a]: https://quickdocs.org/40ants-logging
[07be]: https://quickdocs.org/global-vars
[7f8b]: https://quickdocs.org/log4cl
[b440]: https://quickdocs.org/slynk
[e044]: https://quickdocs.org/slynk-macrostep
[433f]: https://quickdocs.org/slynk-named-readtables
* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]
0.1.0
40ants-asdf-system (system).
slynk/mrepl (system).
40ants-slynk/core (system).
40ants-slynk/coreAlexander Artemenko <svetlyak.40wt@gmail.com>
(GIT https://github.com/40ants/slynk)
Unlicense
log4cl (system).
global-vars (system).
slynk (system).
slynk-macrostep (system).
slynk-named-readtables (system).
40ants-logging (system).
Files are sorted by type and then listed depth-first from the systems components trees.
40ants-slynk/core/file-type.lisp40ants-slynk/core (system).
start-slynk-if-needed (function).
on-connection-close (function).
on-connection-open (function).
Packages are listed by definition order.
40ants-slynk40ants-slynk/core
common-lisp.
start-slynk-if-needed (function).
on-connection-close (function).
on-connection-open (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Use this function before starting the backend server.
If SLYNK_PORT environment variable is set, then this function will create a Slynk server on that port and localhost interface. To change an interface, set SLYNK_INTERFACE environment variable.
| Jump to: | F O S |
|---|
| Jump to: | F O S |
|---|
| Jump to: | 4
F P S |
|---|
| Jump to: | 4
F P S |
|---|