This is the zmq Reference Manual, version 1.5.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 21:04:55 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
zmq/srczmq (system).
packages.lisp (file).
grovel.lisp (file).
ffi.lisp (file).
zmq.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
zmq/src/ffi.lispgrovel.lisp (file).
src (module).
%bind (function).
%close (function).
%connect (function).
%device (function).
%errno (function).
%getsockopt (function).
%init (function).
%memcpy (function).
%msg-close (function).
%msg-copy (function).
%msg-data (function).
%msg-init (function).
%msg-init-data (function).
%msg-init-size (function).
%msg-move (function).
%msg-size (function).
%poll (function).
%setsockopt (function).
%sleep (function).
%socket (function).
%stopwatch-start (function).
%stopwatch-stop (function).
%strerror (function).
%term (function).
%version (function).
zmq/src/zmq.lispffi.lisp (file).
src (module).
bind (function).
close (function).
connect (function).
device (function).
do-poll-items (macro).
eaddrinuse-error (condition).
eaddrnotavail-error (condition).
eagain-error (condition).
econnrefused-error (condition).
efault-error (condition).
efsm-error (condition).
einprogress-error (condition).
eintr-error (condition).
einval-error (condition).
emfile-error (condition).
emthread-error (condition).
enetdown-error (condition).
enobufs-error (condition).
enocompatproto-error (condition).
enodev-error (condition).
enomem-error (condition).
enotsock-error (condition).
enotsup-error (condition).
eprotonosupport-error (condition).
eterm-error (condition).
getsockopt (function).
init (function).
msg-close (function).
msg-copy (function).
msg-data (function).
msg-data-array (function).
msg-data-string (function).
msg-init (function).
msg-init-data (function).
msg-init-size (function).
msg-move (function).
msg-size (function).
poll (function).
poll-item-events-signaled-p (function).
poll-item-fd (function).
poll-item-socket (function).
poll-items-aref (macro).
recv (function).
send (function).
setsockopt (function).
sleep (function).
socket (function).
socket (class).
socket-%socket (reader method).
(setf socket-%socket) (writer method).
socket-events (function).
socket-fd (function).
socket-lock (reader method).
(setf socket-lock) (writer method).
stopwatch-start (function).
stopwatch-stop (function).
term (function).
version (function).
with-context (macro).
with-msg-init (macro).
with-msg-init-data (macro).
with-msg-init-size (macro).
with-poll-items (macro).
with-socket (macro).
with-socket-locked (macro).
with-sockets (macro).
with-stopwatch (macro).
zmq-error (condition).
*errors* (special variable).
*socket-options-type* (special variable).
call-ffi (function).
define-error (macro).
define-sockopt-type (function).
defun-zmq3 (macro).
msg-init-fill (function).
zmq-error-code (reader method).
zmq-error-description (reader method).
Packages are listed by definition order.
zmqcffi.
common-lisp.
bind (function).
close (function).
connect (function).
device (function).
do-poll-items (macro).
eaddrinuse-error (condition).
eaddrnotavail-error (condition).
eagain-error (condition).
econnrefused-error (condition).
efault-error (condition).
efsm-error (condition).
einprogress-error (condition).
eintr-error (condition).
einval-error (condition).
emfile-error (condition).
emthread-error (condition).
enetdown-error (condition).
enobufs-error (condition).
enocompatproto-error (condition).
enodev-error (condition).
enomem-error (condition).
enotsock-error (condition).
enotsup-error (condition).
eprotonosupport-error (condition).
eterm-error (condition).
getsockopt (function).
init (function).
msg-close (function).
msg-copy (function).
msg-data (function).
msg-data-array (function).
msg-data-string (function).
msg-init (function).
msg-init-data (function).
msg-init-size (function).
msg-move (function).
msg-size (function).
poll (function).
poll-item-events-signaled-p (function).
poll-item-fd (function).
poll-item-socket (function).
poll-items-aref (macro).
recv (function).
send (function).
setsockopt (function).
sleep (function).
socket (function).
socket (class).
socket-%socket (generic reader).
(setf socket-%socket) (generic writer).
socket-events (function).
socket-fd (function).
socket-lock (generic reader).
(setf socket-lock) (generic writer).
stopwatch-start (function).
stopwatch-stop (function).
term (function).
version (function).
with-context (macro).
with-msg-init (macro).
with-msg-init-data (macro).
with-msg-init-size (macro).
with-poll-items (macro).
with-socket (macro).
with-socket-locked (macro).
with-sockets (macro).
with-stopwatch (macro).
zmq-error (condition).
%bind (function).
%close (function).
%connect (function).
%device (function).
%errno (function).
%getsockopt (function).
%init (function).
%memcpy (function).
%msg-close (function).
%msg-copy (function).
%msg-data (function).
%msg-init (function).
%msg-init-data (function).
%msg-init-size (function).
%msg-move (function).
%msg-size (function).
%poll (function).
%setsockopt (function).
%sleep (function).
%socket (function).
%stopwatch-start (function).
%stopwatch-stop (function).
%strerror (function).
%term (function).
%version (function).
*errors* (special variable).
*socket-options-type* (special variable).
call-ffi (function).
define-error (macro).
define-sockopt-type (function).
defun-zmq3 (macro).
msg-init-fill (function).
zmq-error-code (generic reader).
zmq-error-description (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
For each poll item in ITEMS, evaluate BODY in an environment where VAR is bound to the poll item.
Return a foreign pointer on the poll item of indice I in the foreign array ITEMS.
Evaluate BODY in an environment where VAR is bound to a context created with IO-THREADS threads.
Evaluate BODY in an environment where VAR is bound to a new empty message.
Evaluate BODY in an environment where VAR is bound to a new message filled with DATA. If DATA is a string, it is encoded using the character coding schema ENCODING.
Evaluate BODY in an environment where VAR is bound to a new message of size SIZE.
Evaluate BODY in an environment where ITEMS-VAR is bound to a foreign array
of poll items, and SIZE-VAR is bound to the number of polled items. Poll
items are filled according to ITEMS. ITEMS is a list where each element
describe a poll item. Each description is a list where the first element is
a socket instance, a foreign pointer to a zeromq socket, or a file
descriptor, and other elements are the events to watch
for, :POLLIN, :POLLOUT or :POLLERR.
Evaluate BODY in an environment where VAR is bound to a socket created in context CONTEXT with type TYPE. Key arguments are the same as the arguments of SOCKET.
Evaluate BODY in an environment where SOCKET is protected against concurrent access.
Start a timer, evaluate BODY, stop the timer, and return the elapsed time.
Bind SOCKET to the address ENDPOINT.
Connect SOCKET to the address ENDPOINT.
Connect a frontend socket to a backend socket. This function always returns -1.
Get the value currently associated to a socket option.
Release a message, freeing any memory allocated for the message.
Copy the content of the message SOURCE to the message DESTINATION.
Get a foreign pointer on the content of MESSAGE.
Get the content of MESSAGE as an unsigned byte array.
Get the content of MESSAGE as a character string. The string is decoded using the character coding schema ENCODING.
Create and return a new message initialized and filled with DATA. If DATA is a string, it is encoded using the character coding schema ENCODING.
Create and return a new message initialized to a fixed size SIZE.
Move the content of the message SOURCE to the message DESTINATION. After the call, SOURCE is an empty message.
Return the size in byte of the content of MESSAGE.
Poll ITEMS with a timeout of TIMEOUT milliseconds, -1 meaning no time limit. Return the number of items with signaled events.
Return T if POLL-ITEM indicates that one or more of the listed EVENTS types was detected for the underlying socket or file descriptor or NIL if no event occurred.
Return the file descriptor of the poll item POLL-ITEM.
Return a foreign pointer to the zeromq socket of the poll item POLL-ITEM.
Receive a message from SOCKET and store it in MESSAGE.
Queue MESSAGE to be sent on SOCKET.
Set the value associated to a socket option.
Create and return a new socket. If THREAD-SAFE is not NIL, the socket will be protected against concurrent access.
Return a list of events representing the current event state of
SOCKET. Look at the official documentation of ZMQ_EVENTS for getsockopt()
for more information.
Return the file descriptor associated with SOCKET. This file descriptor can be used to integrate SOCKET into an existing event loop. Look at the official documentation of ZMQ_FD for getsockopt() for more information.
Stop the timer referenced by HANDLE, and return the number of microseconds elapsed since the timer was started.
Return the version of the ZMQ library, a list of three integers (major, minor and patch version).
The error associated to the EADDRINUSE error code.
The error associated to the EADDRNOTAVAIL error code.
The error associated to the EAGAIN error code.
The error associated to the ECONNREFUSED error code.
The error associated to the EFAULT error code.
The error associated to the EFSM error code.
The error associated to the EINPROGRESS error code.
The error associated to the EINTR error code.
The error associated to the EINVAL error code.
The error associated to the EMFILE error code.
The error associated to the EMTHREAD error code.
The error associated to the ENETDOWN error code.
The error associated to the ENOBUFS error code.
The error associated to the ENOCOMPATPROTO error code.
The error associated to the ENODEV error code.
The error associated to the ENOMEM error code.
The error associated to the ENOTSOCK error code.
The error associated to the ENOTSUP error code.
The error associated to the EPROTONOSUPPORT error code.
The error associated to the ETERM error code.
A ZMQ error.
zmq.
error.
eaddrinuse-error.
eaddrnotavail-error.
eagain-error.
econnrefused-error.
efault-error.
efsm-error.
einprogress-error.
eintr-error.
einval-error.
emfile-error.
emthread-error.
enetdown-error.
enobufs-error.
enocompatproto-error.
enodev-error.
enomem-error.
enotsock-error.
enotsup-error.
eprotonosupport-error.
eterm-error.
The numeric error code.
:code
This slot is read-only.
The description of the error.
:description
This slot is read-only.
A zeromq socket.
A table mapping error numbers to their condition class
A table to store the foreign type of each socket option.
Define a function which is only available in ZeroMQ 3.2. Using the function with ZeroMQ 2.x will raise an error.
Call a low-level function and check its return value. If the return value is equal to INVALID-VALUE, a suitable error is signaled. When the error code tells that the function was interrupted by a signal (EINTR), the function is called until it succeeds. In any case, the return value of the low-level function is returned.
Initialize, fill and return a message. If DATA is a string, convert it to a byte array.
| Jump to: | %
(
B C D F G I M P R S T V W Z |
|---|
| Jump to: | %
(
B C D F G I M P R S T V W Z |
|---|
| Jump to: | %
*
C D L S |
|---|
| Jump to: | %
*
C D L S |
|---|
| Jump to: | C E F G M P S Z |
|---|
| Jump to: | C E F G M P S Z |
|---|