The zmq Reference Manual

Table of Contents

The zmq Reference Manual

This is the zmq Reference Manual, version 1.5.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:15:57 2020 GMT+0.

1 Introduction

lisp-zmq

WARNING I have not use this system for years and do not maintain it. Feel free to contact me if you are interested to take ownership of it.

Description

lisp-zmq is a Common Lisp binding for the zeromq messaging library.

More information can be found on http://wandrian.net/lisp-zmq.html.

Compatibility

This binding is compatible with both stable ZeroMQ API available, i.e. ZeroMQ 2.2.x and ZeroMQ 3.2.x with x greater or equal to 2. ZeroMQ 3.0.0 (alpha), ZeroMQ 3.1.0 (beta), ZeroMQ 3.2.0 (RC1) and ZeroMQ 3.2.1 (RC2) are not supported.

In lisp-zmq, 2.x designates the 2.2.x version, and 3.x designates the 3.2.x — with x greater or equal to 2 — version.

Contact

If you have suggestions, or if you have found a bug, send me a message via Github or mail me at <khaelin@gmail.co

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 zmq

Author

Nicolas Martyanoff

License

BSD

Description

A binding of the zmq transport layer.

Version

1.5.0

Dependencies

• cffi
• bordeaux-threads
• trivial-features

Source

zmq.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 zmq/src

Parent

zmq (system)

Location

src/

Components

• packages.lisp (file)
• grovel.lisp (file)
• ffi.lisp (file)
• zmq.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 zmq.asd

Location

zmq.asd

Systems

zmq (system)

4.1.2 zmq/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

zmq

4.1.3 zmq/src/grovel.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/grovel.lisp

4.1.4 zmq/src/ffi.lisp

Dependency

grovel.lisp (file)

Parent

src (module)

Location

src/ffi.lisp

Internal Definitions

• %bind (function)
• %close (function)
• %connect (function)
• %ctx-destroy (function)
• %ctx-get (function)
• %ctx-new (function)
• %ctx-set (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-recv (function)
• %msg-send (function)
• %msg-size (function)
• %poll (function)
• %proxy (function)
• %recvmsg (function)
• %sendmsg (function)
• %setsockopt (function)
• %sleep (function)
• %socket (function)
• %stopwatch-start (function)
• %stopwatch-stop (function)
• %strerror (function)
• %term (function)
• %unbind (function)
• %version (function)

4.1.5 zmq/src/zmq.lisp

Dependency

ffi.lisp (file)

Parent

src (module)

Location

src/zmq.lisp

Exported Definitions

• bind (function)
• close (function)
• connect (function)
• ctx-destroy (function)
• ctx-get (function)
• ctx-new (function)
• ctx-set (function)
• device (function)
• disconnect (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-recv (function)
• msg-send (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 (method)
• (setf socket-%socket) (method)
• socket-events (function)
• socket-fd (function)
• socket-lock (method)
• (setf socket-lock) (method)
• stopwatch-start (function)
• stopwatch-stop (function)
• term (function)
• unbind (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)

Internal Definitions

• *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 (method)
• zmq-error-description (method)

5 Packages

Packages are listed by definition order.

5.1 zmq

Source

packages.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• bind (function)
• close (function)
• connect (function)
• ctx-destroy (function)
• ctx-get (function)
• ctx-new (function)
• ctx-set (function)
• device (function)
• disconnect (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-recv (function)
• msg-send (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 function)
• socket-%socket (method)
• (setf socket-%socket) (method)
• (setf socket-%socket) (generic function)
• socket-events (function)
• socket-fd (function)
• socket-lock (generic function)
• socket-lock (method)
• (setf socket-lock) (method)
• (setf socket-lock) (generic function)
• stopwatch-start (function)
• stopwatch-stop (function)
• term (function)
• unbind (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)
• zmq-version-major (constant)
• zmq-version-minor (constant)

Internal Definitions

• %bind (function)
• %close (function)
• %connect (function)
• %ctx-destroy (function)
• %ctx-get (function)
• %ctx-new (function)
• %ctx-set (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-recv (function)
• %msg-send (function)
• %msg-size (function)
• %poll (function)
• %proxy (function)
• %recvmsg (function)
• %sendmsg (function)
• %setsockopt (function)
• %sleep (function)
• %socket (function)
• %stopwatch-start (function)
• %stopwatch-stop (function)
• %strerror (function)
• %term (function)
• %unbind (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)
• msg-tclass (class)
• pollitem-tclass (class)
• size-of-msg (constant)
• size-of-pollitem (constant)
• size-of-size-t (constant)
• zmq-error-code (generic function)
• zmq-error-code (method)
• zmq-error-description (generic function)
• zmq-error-description (method)
• zmq-version-patch (constant)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Constants

Constant: zmq-version-major

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

Constant: zmq-version-minor

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

6.1.2 Macros

Macro: do-poll-items (VAR ITEMS NB-ITEMS) &body BODY

For each poll item in ITEMS, evaluate BODY in an environment where VAR is bound to the poll item.

Package

zmq

Source

zmq.lisp (file)

Macro: poll-items-aref ITEMS I

Return a foreign pointer on the poll item of indice I in the foreign array ITEMS.

Package

zmq

Source

zmq.lisp (file)

Macro: with-context (VAR IO-THREADS) &body BODY

Evaluate BODY in an environment where VAR is bound to a context created with IO-THREADS threads.

Package

zmq

Source

zmq.lisp (file)

Macro: with-msg-init (VAR) &body BODY

Evaluate BODY in an environment where VAR is bound to a new empty message.

Package

zmq

Source

zmq.lisp (file)

Macro: with-msg-init-data (VAR DATA &key ENCODING) &body BODY

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.

Package

zmq

Source

zmq.lisp (file)

Macro: with-msg-init-size (VAR SIZE) &body BODY

Evaluate BODY in an environment where VAR is bound to a new message of size SIZE.

Package

zmq

Source

zmq.lisp (file)

Macro: with-poll-items (ITEMS-VAR SIZE-VAR) ITEMS &body BODY

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.

Package

zmq

Source

zmq.lisp (file)

Macro: with-socket (VAR CONTEXT TYPE &key THREAD-SAFE) &body BODY

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.

Package

zmq

Source

zmq.lisp (file)

Macro: with-socket-locked (SOCKET) &body BODY

Evaluate BODY in an environment where SOCKET is protected against concurrent access.

Package

zmq

Source

zmq.lisp (file)

Macro: with-sockets BINDINGS &body BODY

Package

zmq

Source

zmq.lisp (file)

Macro: with-stopwatch &body BODY

Start a timer, evaluate BODY, stop the timer, and return the elapsed time.

Package

zmq

Source

zmq.lisp (file)

6.1.3 Functions

Function: bind SOCKET ENDPOINT

Bind SOCKET to the address ENDPOINT.

Package

zmq

Source

zmq.lisp (file)

Function: close SOCKET

Close and release a socket.

Package

zmq

Source

zmq.lisp (file)

Function: connect SOCKET ENDPOINT

Connect SOCKET to the address ENDPOINT.

Package

zmq

Source

zmq.lisp (file)

Function: ctx-destroy CONTEXT

Destroy a context.

Package

zmq

Source

zmq.lisp (file)

Function: ctx-get CONTEXT OPTION

Return the value associated to the option OPTION for CONTEXT.

Package

zmq

Source

zmq.lisp (file)

Function: ctx-new ()

Create and return a new context.

Package

zmq

Source

zmq.lisp (file)

Function: ctx-set CONTEXT OPTION VALUE

Set the value associated to the option OPTION to VALUE for CONTEXT.

Package

zmq

Source

zmq.lisp (file)

Function: device TYPE FRONTEND BACKEND

Connect a frontend socket to a backend socket. This function always returns -1.

Package

zmq

Source

zmq.lisp (file)

Function: disconnect SOCKET ENDPOINT

Disconnect SOCKET from the address ENDPOINT.

Package

zmq

Source

zmq.lisp (file)

Function: getsockopt SOCKET OPTION

Get the value currently associated to a socket option.

Package

zmq

Source

zmq.lisp (file)

Function: init IO-THREADS

Create and return a new context.

Package

zmq

Source

zmq.lisp (file)

Function: msg-close MESSAGE

Release a message, freeing any memory allocated for the message.

Package

zmq

Source

zmq.lisp (file)

Function: msg-copy DESTINATION SOURCE

Copy the content of the message SOURCE to the message DESTINATION.

Package

zmq

Source

zmq.lisp (file)

Function: msg-data MESSAGE

Get a foreign pointer on the content of MESSAGE.

Package

zmq

Source

zmq.lisp (file)

Function: msg-data-array MESSAGE

Get the content of MESSAGE as an unsigned byte array.

Package

zmq

Source

zmq.lisp (file)

Function: msg-data-string MESSAGE &key ENCODING

Get the content of MESSAGE as a character string. The string is decoded using the character coding schema ENCODING.

Package

zmq

Source

zmq.lisp (file)

Function: msg-init ()

Create and return a new empty message.

Package

zmq

Source

zmq.lisp (file)

Function: msg-init-data DATA &key 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.

Package

zmq

Source

zmq.lisp (file)

Function: msg-init-size SIZE

Create and return a new message initialized to a fixed size SIZE.

Package

zmq

Source

zmq.lisp (file)

Function: msg-move DESTINATION SOURCE

Move the content of the message SOURCE to the message DESTINATION. After the call, SOURCE is an empty message.

Package

zmq

Source

zmq.lisp (file)

Function: msg-recv MESSAGE SOCKET &optional FLAGS

Receive a message from SOCKET and store it in MESSAGE.

Package

zmq

Source

zmq.lisp (file)

Function: msg-send MESSAGE SOCKET &optional FLAGS

Send MESSAGE on SOCKET.

Package

zmq

Source

zmq.lisp (file)

Function: msg-size MESSAGE

Return the size in byte of the content of MESSAGE.

Package

zmq

Source

zmq.lisp (file)

Function: poll ITEMS NB-ITEMS TIMEOUT

Poll ITEMS with a timeout of TIMEOUT milliseconds, -1 meaning no time limit. Return the number of items with signaled events.

Package

zmq

Source

zmq.lisp (file)

Function: poll-item-events-signaled-p POLL-ITEM &rest 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.

Package

zmq

Source

zmq.lisp (file)

Function: poll-item-fd POLL-ITEM

Return the file descriptor of the poll item POLL-ITEM.

Package

zmq

Source

zmq.lisp (file)

Function: poll-item-socket POLL-ITEM

Return a foreign pointer to the zeromq socket of the poll item POLL-ITEM.

Package

zmq

Source

zmq.lisp (file)

Function: recv SOCKET MESSAGE &optional FLAGS

Receive a message from SOCKET and store it in MESSAGE.

Package

zmq

Source

zmq.lisp (file)

Function: send SOCKET MESSAGE &optional FLAGS

Queue MESSAGE to be sent on SOCKET.

Package

zmq

Source

zmq.lisp (file)

Function: setsockopt SOCKET OPTION VALUE

Set the value associated to a socket option.

Package

zmq

Source

zmq.lisp (file)

Function: sleep SECONDS

Sleep for SECONDS seconds.

Package

zmq

Source

zmq.lisp (file)

Function: socket CONTEXT TYPE &key THREAD-SAFE

Create and return a new socket. If THREAD-SAFE is not NIL, the socket will be protected against concurrent access.

Package

zmq

Source

zmq.lisp (file)

Function: socket-events SOCKET

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.

Package

zmq

Source

zmq.lisp (file)

Function: socket-fd SOCKET

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.

Package

zmq

Source

zmq.lisp (file)

Function: stopwatch-start ()

Start a timer, and return a handle.

Package

zmq

Source

zmq.lisp (file)

Function: stopwatch-stop HANDLE

Stop the timer referenced by HANDLE, and return the number of microseconds elapsed since the timer was started.

Package

zmq

Source

zmq.lisp (file)

Function: term CONTEXT

Terminate and release a context

Package

zmq

Source

zmq.lisp (file)

Function: unbind SOCKET ENDPOINT

Unbind SOCKET from the address ENDPOINT.

Package

zmq

Source

zmq.lisp (file)

Function: version ()

Return the version of the ZMQ library, a list of three integers (major, minor and patch version).

Package

zmq

Source

zmq.lisp (file)

6.1.4 Generic functions

Generic Function: socket-%socket OBJECT

Generic Function: (setf socket-%socket) NEW-VALUE OBJECT

Package

zmq

Methods

Method: socket-%socket (SOCKET socket)

Method: (setf socket-%socket) NEW-VALUE (SOCKET socket)

A foreign pointer to the underlying zeromq socket.

Source

zmq.lisp (file)

Generic Function: socket-lock OBJECT

Generic Function: (setf socket-lock) NEW-VALUE OBJECT

Package

zmq

Methods

Method: socket-lock (SOCKET socket)

Method: (setf socket-lock) NEW-VALUE (SOCKET socket)

A lock used for thread-safe sockets, or NIL if the socket isn’t thread-safe.

Source

zmq.lisp (file)

6.1.5 Conditions

Condition: eaddrinuse-error ()

The error associated to the EADDRINUSE error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: eaddrnotavail-error ()

The error associated to the EADDRNOTAVAIL error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: eagain-error ()

The error associated to the EAGAIN error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: econnrefused-error ()

The error associated to the ECONNREFUSED error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: efault-error ()

The error associated to the EFAULT error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: efsm-error ()

The error associated to the EFSM error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: einprogress-error ()

The error associated to the EINPROGRESS error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: eintr-error ()

The error associated to the EINTR error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: einval-error ()

The error associated to the EINVAL error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: emfile-error ()

The error associated to the EMFILE error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: emthread-error ()

The error associated to the EMTHREAD error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enetdown-error ()

The error associated to the ENETDOWN error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enobufs-error ()

The error associated to the ENOBUFS error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enocompatproto-error ()

The error associated to the ENOCOMPATPROTO error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enodev-error ()

The error associated to the ENODEV error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enomem-error ()

The error associated to the ENOMEM error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enotsock-error ()

The error associated to the ENOTSOCK error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: enotsup-error ()

The error associated to the ENOTSUP error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: eprotonosupport-error ()

The error associated to the EPROTONOSUPPORT error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: eterm-error ()

The error associated to the ETERM error code.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

zmq-error (condition)

Condition: zmq-error ()

A ZMQ error.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• einval-error (condition)
• enodev-error (condition)
• eintr-error (condition)
• efault-error (condition)
• enomem-error (condition)
• eagain-error (condition)
• emfile-error (condition)
• enotsup-error (condition)
• eprotonosupport-error (condition)
• enobufs-error (condition)
• enetdown-error (condition)
• eaddrinuse-error (condition)
• eaddrnotavail-error (condition)
• econnrefused-error (condition)
• einprogress-error (condition)
• enotsock-error (condition)
• efsm-error (condition)
• enocompatproto-error (condition)
• eterm-error (condition)
• emthread-error (condition)

Direct methods

• zmq-error-description (method)
• zmq-error-code (method)

Direct slots

Slot: code

The numeric error code.

Initargs

:code

Readers

zmq-error-code (generic function)

Slot: description

The description of the error.

Initargs

:description

Readers

zmq-error-description (generic function)

6.1.6 Classes

Class: socket ()

A zeromq socket.

Package

zmq

Source

zmq.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• socket-lock (method)
• socket-lock (method)
• socket-%socket (method)
• socket-%socket (method)

Direct slots

Slot: %socket

A foreign pointer to the underlying zeromq socket.

Initargs

:%socket

Readers

socket-%socket (generic function)

Writers

(setf socket-%socket) (generic function)

Slot: lock

A lock used for thread-safe sockets, or NIL if the socket isn’t thread-safe.

Initargs

:lock

Readers

socket-lock (generic function)

Writers

(setf socket-lock) (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: size-of-msg

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

Constant: size-of-pollitem

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

Constant: size-of-size-t

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

Constant: zmq-version-patch

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

6.2.2 Special variables

Special Variable: *errors*

A table mapping error numbers to their condition class

Package

zmq

Source

zmq.lisp (file)

Special Variable: *socket-options-type*

A table to store the foreign type of each socket option.

Package

zmq

Source

zmq.lisp (file)

6.2.3 Macros

Macro: define-error NAME ERROR-VALUE

Package

zmq

Source

zmq.lisp (file)

Macro: defun-zmq3 NAME (&rest ARGS) &rest BODY

Define a function which is only available in ZeroMQ 3.2. Using the function with ZeroMQ 2.x will raise an error.

Package

zmq

Source

zmq.lisp (file)

6.2.4 Functions

Function: %bind SOCKET ENDPOINT

Package

zmq

Source

ffi.lisp (file)

Function: %close SOCKET

Package

zmq

Source

ffi.lisp (file)

Function: %connect SOCKET ENDPOINT

Package

zmq

Source

ffi.lisp (file)

Function: %ctx-destroy CONTEXT

Package

zmq

Source

ffi.lisp (file)

Function: %ctx-get CONTEXT OPTION

Package

zmq

Source

ffi.lisp (file)

Function: %ctx-new ()

Package

zmq

Source

ffi.lisp (file)

Function: %ctx-set CONTEXT OPTION OPTVAL

Package

zmq

Source

ffi.lisp (file)

Function: %device DEVICE FRONTEND BACKEND

Package

zmq

Source

ffi.lisp (file)

Function: %errno ()

Package

zmq

Source

ffi.lisp (file)

Function: %getsockopt SOCKET OPTION-NAME OPTION-VALUE OPTION-LEN

Package

zmq

Source

ffi.lisp (file)

Function: %init IO-THREADS

Package

zmq

Source

ffi.lisp (file)

Function: %memcpy DST SRC LEN

Package

zmq

Source

ffi.lisp (file)

Function: %msg-close MSG

Package

zmq

Source

ffi.lisp (file)

Function: %msg-copy DEST SRC

Package

zmq

Source

ffi.lisp (file)

Function: %msg-data MSG

Package

zmq

Source

ffi.lisp (file)

Function: %msg-init MSG

Package

zmq

Source

ffi.lisp (file)

Function: %msg-init-data MSG DATA SIZE FFN HINT

Package

zmq

Source

ffi.lisp (file)

Function: %msg-init-size MSG SIZE

Package

zmq

Source

ffi.lisp (file)

Function: %msg-move DEST SRC

Package

zmq

Source

ffi.lisp (file)

Function: %msg-recv MSG SOCKET FLAGS

Package

zmq

Source

ffi.lisp (file)

Function: %msg-send MSG SOCKET FLAGS

Package

zmq

Source

ffi.lisp (file)

Function: %msg-size MSG

Package

zmq

Source

ffi.lisp (file)

Function: %poll ITEMS NITEMS TIMEOUT

Package

zmq

Source

ffi.lisp (file)

Function: %proxy FRONTEND BACKEND CAPTURE

Package

zmq

Source

ffi.lisp (file)

Function: %recvmsg SOCKET MSG FLAGS

Package

zmq

Source

ffi.lisp (file)

Function: %sendmsg SOCKET MSG FLAGS

Package

zmq

Source

ffi.lisp (file)

Function: %setsockopt SOCKET OPTION-NAME OPTION-VALUE OPTION-LEN

Package

zmq

Source

ffi.lisp (file)

Function: %sleep SECONDS

Package

zmq

Source

ffi.lisp (file)

Function: %socket CONTEXT TYPE

Package

zmq

Source

ffi.lisp (file)

Function: %stopwatch-start ()

Package

zmq

Source

ffi.lisp (file)

Function: %stopwatch-stop WATCH

Package

zmq

Source

ffi.lisp (file)

Function: %strerror ERRNUM

Package

zmq

Source

ffi.lisp (file)

Function: %term CONTEXT

Package

zmq

Source

ffi.lisp (file)

Function: %unbind SOCKET ENDPOINT

Package

zmq

Source

ffi.lisp (file)

Function: %version MAJOR MINOR PATCH

Package

zmq

Source

ffi.lisp (file)

Function: call-ffi INVALID-VALUE FUNCTION &rest ARGS

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.

Package

zmq

Source

zmq.lisp (file)

Function: define-sockopt-type OPTION TYPE &optional LENGTH

Package

zmq

Source

zmq.lisp (file)

Function: msg-init-fill MESSAGE DATA &key ENCODING

Initialize, fill and return a message. If DATA is a string, convert it to a byte array.

Package

zmq

Source

zmq.lisp (file)

6.2.5 Generic functions

Generic Function: zmq-error-code CONDITION

Package

zmq

Methods

Method: zmq-error-code (CONDITION zmq-error)

Source

zmq.lisp (file)

Generic Function: zmq-error-description CONDITION

Package

zmq

Methods

Method: zmq-error-description (CONDITION zmq-error)

Source

zmq.lisp (file)

6.2.6 Classes

Class: msg-tclass ()

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: pollitem-tclass ()

Package

zmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/lisp-zmq-20200218-git/src/grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types