This is the find-port Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 18:04:17 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
find-port
Find open ports programmatically.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:eudoxia0/find-port.git)
MIT
# find-port
![GitHub Actions build status badge.](https://github.com/eudoxia0/find-port/actions/workflows/test.yaml/badge.svg)
[![Quicklisp](http://quickdocs.org/badge/find-port.svg)](http://quickdocs.org/find-port/)
Find open ports programmatically.
# Overview
“‘lisp
CL-USER> (find-port:port-open-p 5000)
T
CL-USER> (my-clack-app:start)
To load "clack-handler-hunchentoot":
Load 1 ASDF system:
clack-handler-hunchentoot
; Loading "clack-handler-hunchentoot"
Hunchentoot server is started.
Listening on localhost:5000.
T
CL-USER> (find-port:port-open-p 5000)
NIL
CL-USER> (find-port:find-port)
50123
“‘
# Usage
The ‘port-open-p‘ function takes an integer and determines whether a port by
that number is open.
The ‘find-port‘ function, by default takes no arguments, and returns an open
port. Two keyword arguments, ‘:min‘ and ‘:max‘, may be given to constrain the
port range in which to search for ports.
By default, the range is from 40000 to 50000, since this function will probably
be used e.g. to pick an open port for testing, rather than to pick a port to run
a production server on.
# License
Copyright (c) 2015 Fernando Borretti
Licensed under the MIT License.
0.1
usocket
(system).
src
(module).
Modules are listed depth-first from the system components tree.
find-port/src
find-port
(system).
find-port.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
find-port/src/find-port.lisp
src
(module).
*default-interface*
(special variable).
find-port
(function).
port-open-p
(function).
Packages are listed by definition order.
find-port
common-lisp
.
*default-interface*
(special variable).
find-port
(function).
port-open-p
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Jump to: | F P |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
F | |||
find-port : | Public ordinary functions | ||
Function, find-port : | Public ordinary functions | ||
Function, port-open-p : | Public ordinary functions | ||
| |||
P | |||
port-open-p : | Public ordinary functions | ||
|
Jump to: | F P |
---|
Jump to: | *
S |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
* | |||
*default-interface* : | Public special variables | ||
| |||
S | |||
Special Variable, *default-interface* : | Public special variables | ||
|
Jump to: | *
S |
---|
Jump to: | F M P S |
---|
Jump to: | F M P S |
---|