This is the nbd Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:04:12 2025 GMT+0.
nbd/nbd.asdnbd/lib/*/lisp.lispnbd/lib/handshake/file-type.lispnbd/lib/shared/file-type.lispnbd/lib/options/file-type.lispnbd/lib/transmission-flags/file-type.lispnbd/lib/server/file-type.lispnbd/lib/transmission/file-type.lispnbd/api/file-type.lispThe main system appears first, followed by any subsystem dependency.
nbdnbd/lib/*nbd/lib/handshakenbd/lib/sharednbd/lib/optionsnbd/lib/transmission-flagsnbd/lib/servernbd/lib/transmissionnbd/apinbdNetwork Block Device server library.
Florian Margaine <florian@margaine.com>
MIT
wild-package-inferred-system (system).
nbd/lib/*Florian Margaine <florian@margaine.com>
MIT
nbd/lib/handshake (system).
nbd/lib/options (system).
nbd/lib/server (system).
nbd/lib/shared (system).
nbd/lib/transmission-flags (system).
nbd/lib/transmission (system).
lisp.lisp (file).
nbd/lib/handshakeFlorian Margaine <florian@margaine.com>
MIT
nbd/lib/shared (system).
nbd/lib/options (system).
lisp-binary (system).
nbd/lib/transmission-flags (system).
nbd/lib/optionsFlorian Margaine <florian@margaine.com>
MIT
flexi-streams (system).
lisp-binary (system).
nbd/lib/serverFlorian Margaine <florian@margaine.com>
MIT
nbd/lib/shared (system).
nbd/lib/handshake (system).
nbd/lib/transmission (system).
nbd/lib/transmission-flags (system).
bordeaux-threads (system).
sb-bsd-sockets (system).
nbd/lib/transmissionFlorian Margaine <florian@margaine.com>
MIT
nbd/lib/shared (system).
nbd/lib/transmission-flags (system).
lisp-binary (system).
nbd/apiFlorian Margaine <florian@margaine.com>
MIT
nbd/lib/server (system).
nbd/lib/transmission-flags (system).
Files are sorted by type and then listed depth-first from the systems components trees.
nbd/nbd.asdnbd/lib/*/lisp.lispnbd/lib/handshake/file-type.lispnbd/lib/shared/file-type.lispnbd/lib/options/file-type.lispnbd/lib/transmission-flags/file-type.lispnbd/lib/server/file-type.lispnbd/lib/transmission/file-type.lispnbd/api/file-type.lispnbd/lib/handshake/file-type.lispnbd/lib/handshake (system).
handshake (function).
write-binary (method).
write-binary (method).
*nbd-flag-fixed-newstyle* (special variable).
*nbd-flag-no-zeroes* (special variable).
client-handshake (structure).
client-handshake-flags (reader).
(setf client-handshake-flags) (writer).
client-handshake-p (function).
copy-client-handshake (function).
copy-server-handshake (function).
handshake-export-name (function).
handshake-fixed-newstyle (function).
handshake-newstyle (function).
make-client-handshake (function).
make-server-handshake (function).
reply-info-block-size (function).
reply-info-export (function).
server-handshake (structure).
server-handshake-i-have-opt (reader).
(setf server-handshake-i-have-opt) (writer).
server-handshake-magic (reader).
(setf server-handshake-magic) (writer).
server-handshake-p (function).
validate-export-name (function).
nbd/lib/options/file-type.lispnbd/lib/options (system).
info-name (reader method).
info-requests (reader method).
option-type (reader method).
option-value (reader method).
read-option (function).
reply (generic function).
reply (structure).
reply-error (function).
write-binary (method).
write-binary (method).
write-binary (method).
write-binary (method).
%opt-info-and-go (structure).
%opt-info-and-go-name (reader).
(setf %opt-info-and-go-name) (writer).
%opt-info-and-go-p (function).
%opt-info-and-go-requests (reader).
(setf %opt-info-and-go-requests) (writer).
%opt-info-and-go-requests-count (reader).
(setf %opt-info-and-go-requests-count) (writer).
%option (structure).
%option-data (reader).
(setf %option-data) (writer).
%option-magic (reader).
(setf %option-magic) (writer).
%option-p (function).
%option-type (reader).
(setf %option-type) (writer).
*error-reply-types* (special variable).
*info-types* (special variable).
*options-types* (special variable).
*reply-types* (special variable).
casted-value (function).
copy-%opt-info-and-go (function).
copy-%option (function).
copy-reply (function).
copy-server-reply (function).
defreply (macro).
info (class).
integer-to-keyword (function).
keyword-to-integer (function).
make-%opt-info-and-go (function).
make-%option (function).
make-reply (function).
make-server-reply (function).
option (class).
reply-data (reader).
(setf reply-data) (writer).
reply-magic (reader).
(setf reply-magic) (writer).
reply-option-type (reader).
(setf reply-option-type) (writer).
reply-p (function).
reply-reply-type (reader).
(setf reply-reply-type) (writer).
server-reply (structure).
server-reply-data (reader).
(setf server-reply-data) (writer).
server-reply-p (function).
nbd/lib/transmission-flags/file-type.lispnbd/lib/transmission-flags (system).
*can-multi-conn* (special variable).
*has-flags* (special variable).
*read-only* (special variable).
*rotational* (special variable).
*send-cache* (special variable).
*send-df* (special variable).
*send-fast-zero* (special variable).
*send-flush* (special variable).
*send-fua* (special variable).
*send-resize* (special variable).
*send-trim* (special variable).
*send-write-zeroes* (special variable).
nbd/lib/server/file-type.lispnbd/lib/server (system).
*debug-mode* (special variable).
start (function).
wait (function).
*unsupported-flags* (special variable).
accept-loop (method).
handle-client-socket (method).
nbd/lib/transmission/file-type.lispnbd/lib/transmission (system).
transmission (function).
write-binary (method).
write-binary (method).
%reply (structure).
%reply-error-code (reader).
(setf %reply-error-code) (writer).
%reply-handle (reader).
(setf %reply-handle) (writer).
%reply-magic (reader).
(setf %reply-magic) (writer).
%reply-p (function).
%request (structure).
%request-command-flags (reader).
(setf %request-command-flags) (writer).
%request-handle (reader).
(setf %request-handle) (writer).
%request-length (reader).
(setf %request-length) (writer).
%request-magic (reader).
(setf %request-magic) (writer).
%request-offset (reader).
(setf %request-offset) (writer).
%request-p (function).
%request-type (reader).
(setf %request-type) (writer).
*command-flags* (special variable).
*errors* (special variable).
*request-types* (special variable).
copy-%reply (function).
copy-%request (function).
flag-value (function).
make-%reply (function).
make-%request (function).
reply (function).
validate-request (function).
validation-error (condition).
validation-error-code (reader method).
validation-error-message (reader method).
Packages are listed by definition order.
nbd/lib/servernbd/lib/optionsnbd/lib/transmissionnbd/lib/transmission-flagsnbd/lib/sharednbd/apinbd/lib/*nbd/lib/handshakenbd/lib/servercommon-lisp.
nbd/lib/handshake.
nbd/lib/shared.
nbd/lib/transmission.
nbd/lib/transmission-flags.
*debug-mode* (special variable).
start (function).
wait (function).
*unsupported-flags* (special variable).
accept-loop (generic function).
handle-client-socket (generic function).
nbd/lib/optionscommon-lisp.
info-name (generic reader).
info-requests (generic reader).
option-type (generic reader).
option-value (generic reader).
read-option (function).
reply (generic function).
reply (structure).
reply-error (function).
%opt-info-and-go (structure).
%opt-info-and-go-name (reader).
(setf %opt-info-and-go-name) (writer).
%opt-info-and-go-p (function).
%opt-info-and-go-requests (reader).
(setf %opt-info-and-go-requests) (writer).
%opt-info-and-go-requests-count (reader).
(setf %opt-info-and-go-requests-count) (writer).
%option (structure).
%option-data (reader).
(setf %option-data) (writer).
%option-magic (reader).
(setf %option-magic) (writer).
%option-p (function).
%option-type (reader).
(setf %option-type) (writer).
*error-reply-types* (special variable).
*info-types* (special variable).
*options-types* (special variable).
*reply-types* (special variable).
casted-value (function).
copy-%opt-info-and-go (function).
copy-%option (function).
copy-reply (function).
copy-server-reply (function).
defreply (macro).
info (class).
integer-to-keyword (function).
keyword-to-integer (function).
make-%opt-info-and-go (function).
make-%option (function).
make-reply (function).
make-server-reply (function).
option (class).
reply-data (reader).
(setf reply-data) (writer).
reply-magic (reader).
(setf reply-magic) (writer).
reply-option-type (reader).
(setf reply-option-type) (writer).
reply-p (function).
reply-reply-type (reader).
(setf reply-reply-type) (writer).
server-reply (structure).
server-reply-data (reader).
(setf server-reply-data) (writer).
server-reply-p (function).
nbd/lib/transmissioncommon-lisp.
nbd/lib/shared.
nbd/lib/transmission-flags.
transmission (function).
%reply (structure).
%reply-error-code (reader).
(setf %reply-error-code) (writer).
%reply-handle (reader).
(setf %reply-handle) (writer).
%reply-magic (reader).
(setf %reply-magic) (writer).
%reply-p (function).
%request (structure).
%request-command-flags (reader).
(setf %request-command-flags) (writer).
%request-handle (reader).
(setf %request-handle) (writer).
%request-length (reader).
(setf %request-length) (writer).
%request-magic (reader).
(setf %request-magic) (writer).
%request-offset (reader).
(setf %request-offset) (writer).
%request-p (function).
%request-type (reader).
(setf %request-type) (writer).
*command-flags* (special variable).
*errors* (special variable).
*request-types* (special variable).
copy-%reply (function).
copy-%request (function).
flag-value (function).
make-%reply (function).
make-%request (function).
reply (function).
validate-request (function).
validation-error (condition).
validation-error-code (generic reader).
validation-error-message (generic reader).
nbd/lib/transmission-flagscommon-lisp.
*can-multi-conn* (special variable).
*has-flags* (special variable).
*read-only* (special variable).
*rotational* (special variable).
*send-cache* (special variable).
*send-df* (special variable).
*send-fast-zero* (special variable).
*send-flush* (special variable).
*send-fua* (special variable).
*send-resize* (special variable).
*send-trim* (special variable).
*send-write-zeroes* (special variable).
nbd/lib/handshakecommon-lisp.
nbd/lib/options.
nbd/lib/shared.
handshake (function).
*nbd-flag-fixed-newstyle* (special variable).
*nbd-flag-no-zeroes* (special variable).
client-handshake (structure).
client-handshake-flags (reader).
(setf client-handshake-flags) (writer).
client-handshake-p (function).
copy-client-handshake (function).
copy-server-handshake (function).
handshake-export-name (function).
handshake-fixed-newstyle (function).
handshake-newstyle (function).
make-client-handshake (function).
make-server-handshake (function).
reply-info-block-size (function).
reply-info-export (function).
server-handshake (structure).
server-handshake-i-have-opt (reader).
(setf server-handshake-i-have-opt) (writer).
server-handshake-magic (reader).
(setf server-handshake-magic) (writer).
server-handshake-p (function).
validate-export-name (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Currently unsupported. Resources are shared across clients. Influences the behavior of CMD_FLUSH and CMD_FLAG_FUA on the server side.
Is always be set by the server.
If the export is read-only. The server will always return EPERM on writes if set.
Has rotational disk characteristics, IOW doesn’t do random access.
Currently unsupported. Supports CMD_CACHE, aka posix_fadvise().
Currently unsupported. Supports CMD_FLAG_DF.
Currently unsupported. Supports CMD_FLAG_FAST_ZERO.
Supports CMD_FLUSH. The server must flush all data to persistent storage before replying.
Supports CMD_FLAG_FUA. The server must flush all data to persistent storage before handling the request.
Currently unsupported. Supports resizing.
Supports CMD_TRIM. This is a hint that the server can discard the data.
Currently unsupported. Supports CMD_WRITE_ZEROES and CMD_FLAG_NO_HOLE.
Implements replies to options.
%opt-info-and-go) stream-symbol-1) ¶lisp-binary.
server-reply) stream-symbol-1) ¶lisp-binary.
client-handshake) stream-symbol-1) ¶lisp-binary.
server-handshake) stream-symbol-1) ¶lisp-binary.
structure-object.
lisp-binary.
(unsigned-byte 64)
1100100111001001
(unsigned-byte 32)
0
(unsigned-byte 32)
0
(simple-array (unsigned-byte 8))
(make-array 0 :element-type (quote (unsigned-byte 8)))
:socket
This slot is read-only.
common-lisp.
:stream
This slot is read-only.
t
t
accept-loop.
handle-client-socket.
(setf server-accept-thread).
server-accept-thread.
server-export-description.
server-export-name.
server-export-size.
server-max-block-size.
server-min-block-size.
server-on-request.
server-preferred-block-size.
server-socket.
server-stream.
server-supported-flags.
:socket
This slot is read-only.
common-lisp.
:stream
This slot is read-only.
:export-name
This slot is read-only.
:export-description
This slot is read-only.
:export-size
This slot is read-only.
:min-block-size
This slot is read-only.
:preferred-block-size
This slot is read-only.
:max-block-size
This slot is read-only.
:supported-flags
This slot is read-only.
:on-request
This slot is read-only.
name.
data.
type.
type.
data.
data.
validation-error)) ¶validation-error)) ¶structure-object.
string
""
(unsigned-byte 16)
0
(simple-array (unsigned-byte 16))
(make-array 0 :element-type (quote (unsigned-byte 16)))
structure-object.
lisp-binary.
(unsigned-byte 64)
5280542401877725268
common-lisp.
(unsigned-byte 32)
0
(simple-array (unsigned-byte 8))
(make-array 0 :element-type (quote (unsigned-byte 8)))
structure-object.
lisp-binary.
(unsigned-byte 32)
1732535960
(unsigned-byte 32)
0
(unsigned-byte 64)
0
structure-object.
lisp-binary.
(unsigned-byte 32)
627086611
(unsigned-byte 16)
0
common-lisp.
(unsigned-byte 16)
0
(unsigned-byte 64)
0
(unsigned-byte 64)
0
common-lisp.
(unsigned-byte 32)
0
structure-object.
(unsigned-byte 32)
0
structure-object.
(simple-array (unsigned-byte 8))
(make-array 0 :element-type (quote (unsigned-byte 8)))
:requests
This slot is read-only.
| Jump to: | %
(
A C D F G H I K M O R S T V W |
|---|
| Jump to: | %
(
A C D F G H I K M O R S T V W |
|---|
| Jump to: | *
A C D E F H I L M N O P R S T V |
|---|
| Jump to: | *
A C D E F H I L M N O P R S T V |
|---|
| Jump to: | %
C F I L N O P R S V |
|---|
| Jump to: | %
C F I L N O P R S V |
|---|