This is the weft Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:05:36 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
weft
A TCP server framework, like Hunchentoot for TCP.
Matthew Stickney <mtstickney@gmail.com>
MIT
usocket
(system).
bordeaux-threads
(system).
log4cl
(system).
trivial-timeout
(system).
package.lisp
(file).
weft.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
weft/weft.lisp
package.lisp
(file).
weft
(system).
*shutdown*
(symbol macro).
add-task
(generic function).
all-tasks
(generic function).
find-task
(generic function).
initialize-instance
(method).
manager-full-error
(condition).
remove-task
(generic function).
run
(generic function).
server
(class).
server-address
(reader method).
(setf server-address)
(writer method).
server-connection-handler
(reader method).
(setf server-connection-handler)
(writer method).
server-port
(reader method).
(setf server-port)
(writer method).
server-socket
(reader method).
(setf server-socket)
(writer method).
server-task-manager
(reader method).
(setf server-task-manager)
(writer method).
slots-available-p
(generic function).
stop
(generic function).
stop-accepting
(generic function).
stop-task
(generic function).
task-manager
(class).
thread-shutdown
(condition).
threaded-task-manager
(class).
%ref-lock
(reader).
(setf %ref-lock)
(writer).
%ref-val
(reader).
(setf %ref-val)
(writer).
*id-counter*
(special variable).
acceptor-func
(function).
connection-handler-func
(function).
copy-ref
(function).
gen-id
(function).
make-ref
(function).
manager
(reader method).
(setf manager)
(writer method).
max-connections
(reader method).
prompt-for
(function).
ref
(structure).
ref-p
(function).
ref-val
(function).
(setf ref-val)
(function).
server-acceptor-task
(reader method).
(setf server-acceptor-task)
(writer method).
server-handler-args
(reader method).
(setf server-handler-args)
(writer method).
shutdown-vars
(reader method).
(setf shutdown-vars)
(writer method).
size-of
(function).
task-count
(reader method).
(setf task-count)
(writer method).
task-exists-error
(condition).
task-id
(reader method).
(setf task-id)
(writer method).
task-limit
(reader method).
(setf task-limit)
(writer method).
task-lock
(reader method).
task-shutdown-p
(generic function).
(setf task-shutdown-p)
(generic function).
tasks
(reader method).
(setf tasks)
(writer method).
Packages are listed by definition order.
weft
common-lisp
.
*shutdown*
(symbol macro).
add-task
(generic function).
all-tasks
(generic function).
find-task
(generic function).
manager-full-error
(condition).
remove-task
(generic function).
run
(generic function).
server
(class).
server-address
(generic reader).
(setf server-address)
(generic writer).
server-connection-handler
(generic reader).
(setf server-connection-handler)
(generic writer).
server-port
(generic reader).
(setf server-port)
(generic writer).
server-socket
(generic reader).
(setf server-socket)
(generic writer).
server-task-manager
(generic reader).
(setf server-task-manager)
(generic writer).
slots-available-p
(generic function).
stop
(generic function).
stop-accepting
(generic function).
stop-task
(generic function).
task-manager
(class).
thread-shutdown
(condition).
threaded-task-manager
(class).
%ref-lock
(reader).
(setf %ref-lock)
(writer).
%ref-val
(reader).
(setf %ref-val)
(writer).
*id-counter*
(special variable).
acceptor-func
(function).
connection-handler-func
(function).
copy-ref
(function).
gen-id
(function).
make-ref
(function).
manager
(generic reader).
(setf manager)
(generic writer).
max-connections
(generic reader).
prompt-for
(function).
ref
(structure).
ref-p
(function).
ref-val
(function).
(setf ref-val)
(function).
server-acceptor-task
(generic reader).
(setf server-acceptor-task)
(generic writer).
server-handler-args
(generic reader).
(setf server-handler-args)
(generic writer).
shutdown-vars
(generic reader).
(setf shutdown-vars)
(generic writer).
size-of
(function).
task-count
(generic reader).
(setf task-count)
(generic writer).
task-exists-error
(condition).
task-id
(generic reader).
(setf task-id)
(generic writer).
task-limit
(generic reader).
(setf task-limit)
(generic writer).
task-lock
(generic reader).
task-shutdown-p
(generic function).
(setf task-shutdown-p)
(generic function).
tasks
(generic reader).
(setf tasks)
(generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Add a task to execute THUNK to MANAGER. Returns a
unique ID for the task. If the manager cannot accept a new task,
signals an error of type MANAGER-FULL-ERROR.
weft
.
threaded-task-manager
) thunk) ¶Return a list of the ids of all tasks in MANAGER.
weft
.
threaded-task-manager
)) ¶Return the entry for TASK-ID from MANAGER.
weft
.
threaded-task-manager
) (task symbol
)) ¶Remove TASK from the task-manager MANAGER.
weft
.
threaded-task-manager
) (task symbol
)) ¶Return T if there is capacity to add a new task to MANAGER, NIL otherwise.
weft
.
threaded-task-manager
)) ¶Perform shutdown of the TASK in MANAGER.
weft
.
threaded-task-manager
) (task symbol
)) ¶server
) &key max-connections manager &allow-other-keys) ¶weft
.
initialize-instance
.
max-connections
.
run
.
(setf server-acceptor-task)
.
server-acceptor-task
.
(setf server-address)
.
server-address
.
(setf server-connection-handler)
.
server-connection-handler
.
(setf server-handler-args)
.
server-handler-args
.
(setf server-port)
.
server-port
.
(setf server-socket)
.
server-socket
.
(setf server-task-manager)
.
server-task-manager
.
stop
.
stop-accepting
.
Initarg | Value |
---|---|
:args | (quote nil) |
:manager
:address
:port
:max-connections
This slot is read-only.
:handler
:args
Class implementing a thread-per-connection task manager.
weft
.
(quote nil)
(bordeaux-threads:make-recursive-lock)
This slot is read-only.
(make-hash-table :test (function equal))
Return a wrapper func for HANDLER that will ensure SOCK is closed at exit.
Prompt for a value of type TYPE, using FORMAT-STRING and FORMAT-ARGS to produce the prompt. Signals an error if the value read is not of type TYPE.
weft
.
manager-full-error
)) ¶manager-full-error
)) ¶weft
.
threaded-task-manager
)) ¶automatically generated reader method
weft
.
threaded-task-manager
)) ¶automatically generated writer method
weft
.
task-manager
)) ¶automatically generated reader method
weft
.
task-manager
)) ¶automatically generated writer method
weft
.
task-exists-error
)) ¶task-exists-error
)) ¶weft
.
task-manager
)) ¶automatically generated reader method
weft
.
task-manager
)) ¶automatically generated writer method
weft
.
threaded-task-manager
)) ¶automatically generated reader method
Return a boolean indicating whether the task identified by TASK-ID in MANAGER should shut down.
weft
.
threaded-task-manager
) (task-id symbol
)) ¶Set the shutdown variable for the task identified by TASK-ID in MANAGER to NEW-VAL.
weft
.
threaded-task-manager
) (task-id symbol
)) ¶weft
.
threaded-task-manager
)) ¶automatically generated reader method
weft
.
threaded-task-manager
)) ¶automatically generated writer method
Error thrown when a task with a particular ID already exists.
Jump to: | %
(
A C F G I M P R S T |
---|
Jump to: | %
(
A C F G I M P R S T |
---|
Jump to: | *
A C H I L M P S T V |
---|
Jump to: | *
A C H I L M P S T V |
---|
Jump to: | C F M P R S T W |
---|
Jump to: | C F M P R S T W |
---|