The pzmq Reference Manual

Table of Contents

The pzmq Reference Manual

This is the pzmq Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:46:11 2020 GMT+0.

1 Introduction

ZeroMQ 4.0 bindings

API reference resides at http://orivej.github.io/pzmq/doc/index.html

See examples in examples.lisp.

Merits

• Everything is documented, at least preliminarily.
• Handles interrupts in blocking calls, thanks to Max Mikhanosha: msg-send and msg-recv interrupted by GC are automatically restarted (option *restart-interrupted-calls*).

Deficiencies

Everything not in examples.lisp or tests.lisp has not been tested.

Only those conveniences used in examples and tests have been designed and implemented.

Raw performance has not been fully optimized. This optimization probably matters only for 50000 messages per second or more of 10 kbytes or less, though.

Barebone automatic tests.

Special features (on top of basic features)

• WITH-CONTEXT and WITH-SOCKET accept options for CTX-NEW and SETSOCKOPT.
• WITH-CONTEXT establishes *DEFAULT-CONTEXT* for brevity in WITH-SOCKET.
• WITH-SOCKET establishes *DEFAULT-CONTEXT* when context is neigther specified nor found. Nesting single socket in a context is rather common; combining them together in a single form fits nicely into the common WITH-* paradigm.

2 Systems

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

2.1 pzmq

Author

Orivej Desh <orivej@gmx.fr>

License

Unlicense

Description

ZeroMQ 3.2+ bindings.

Dependency

cffi

Source

pzmq.asd (file)

Components

• package.lisp (file)
• grovel.lisp (file)
• c-api.lisp (file)
• lisp-api.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 pzmq.asd

Location

pzmq.asd

Systems

pzmq (system)

3.1.2 pzmq/package.lisp

Parent

pzmq (system)

Location

package.lisp

Packages

pzmq

3.1.3 pzmq/grovel.lisp

Dependency

package.lisp (file)

Parent

pzmq (system)

Location

grovel.lisp

3.1.4 pzmq/c-api.lisp

Dependency

grovel.lisp (file)

Parent

pzmq (system)

Location

c-api.lisp

Exported Definitions

• *restart-interrupted-calls* (special variable)
• bind (function)
• c-error (condition)
• close (function)
• connect (function)
• ctx-destroy (function)
• ctx-get (function)
• ctx-new (function)
• ctx-set (function)
• ctx-shutdown (function)
• ctx-term (function)
• curve-keypair (function)
• device (function)
• eaddrinuse (condition)
• eaddrnotavail (condition)
• eagain (condition)
• efault (condition)
• efsm (condition)
• ehostunreach (condition)
• eintr (condition)
• einval (condition)
• emfile (condition)
• emthread (condition)
• enocompatproto (condition)
• enodev (condition)
• enoent (condition)
• enomem (condition)
• enotsock (condition)
• enotsup (condition)
• eprotonosupport (condition)
• errno (function)
• eterm (condition)
• getsockopt (function)
• libzmq-error (condition)
• msg-close (function)
• msg-copy (function)
• msg-data (function)
• msg-get (function)
• msg-init (function)
• msg-init-data (function)
• msg-init-size (function)
• msg-more (function)
• msg-move (function)
• msg-recv (function)
• msg-send (function)
• msg-set (function)
• msg-size (function)
• poll (function)
• proxy (function)
• send (function)
• setsockopt (function)
• socket (function)
• strerror (function)
• version (function)

Internal Definitions

• %bind (function)
• %close (function)
• %connect (function)
• %ctx-destroy (function)
• %ctx-get (function)
• %ctx-set (function)
• %ctx-shutdown (function)
• %ctx-term (function)
• %curve-keypair (function)
• %device (function)
• %errno (function)
• %getsockopt (function)
• %msg-close (function)
• %msg-copy (function)
• %msg-get (function)
• %msg-init (function)
• %msg-init-data (function)
• %msg-init-size (function)
• %msg-more (function)
• %msg-move (function)
• %msg-recv (function)
• %msg-send (function)
• %msg-set (function)
• %poll (function)
• %proxy (function)
• %recv (function)
• %send (function)
• %setsockopt (function)
• %socket (function)
• %strerror (function)
• %version (function)
• +io-threads+ (constant)
• +max-sockets+ (constant)
• +more+ (constant)
• c-error-errno (method)
• c-error-keyword (function)
• defcfun* (macro)
• define-conditions (macro)
• libzmq-error-condition (function)
• pollitem-tclass (class)
• with-c-error-check (macro)
• z85-decode (function)
• z85-encode (function)

3.1.5 pzmq/lisp-api.lisp

Dependency

c-api.lisp (file)

Parent

pzmq (system)

Location

lisp-api.lisp

Exported Definitions

• *default-context* (special variable)
• recv-octets (function)
• recv-string (function)
• revents (function)
• with-context (macro)
• with-message (macro)
• with-messages (macro)
• with-poll-items (macro)
• with-socket (macro)
• with-sockets (macro)

4 Packages

Packages are listed by definition order.

4.1 pzmq

ZeroMQ 3.2+ bindings.

Consult @a[http://api.zeromq.org/4-0:zmq]{official C API reference} first.

@begin[Top-level API]{section}
@aboutfun{with-socket}
@aboutfun{with-sockets}
@aboutfun{bind}
@aboutfun{connect}
@aboutfun{recv-string}
@aboutfun{recv-octets}
@aboutfun{send}
@aboutfun{with-poll-items}
@aboutfun{poll}
@aboutfun{revents}
@aboutfun{curve-keypair}
@end{section}

@begin[Middle-level API]{section}
@aboutfun{with-context}
@aboutfun{with-message}
@end{section}

@begin[Low-level API]{section}
@aboutfun{ctx-new}
@aboutfun{ctx-set}
@aboutfun{ctx-get}
@aboutfun{ctx-destroy}
@aboutfun{error}
@aboutfun{strerror}
@aboutfun{version}
@end{section}
@section[Other]{}

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• *default-context* (special variable)
• *restart-interrupted-calls* (special variable)
• bind (function)
• c-error (condition)
• close (function)
• connect (function)
• ctx-destroy (function)
• ctx-get (function)
• ctx-new (function)
• ctx-set (function)
• ctx-shutdown (function)
• ctx-term (function)
• curve-keypair (function)
• device (function)
• eaddrinuse (condition)
• eaddrnotavail (condition)
• eagain (condition)
• efault (condition)
• efsm (condition)
• ehostunreach (condition)
• eintr (condition)
• einval (condition)
• emfile (condition)
• emthread (condition)
• enocompatproto (condition)
• enodev (condition)
• enoent (condition)
• enomem (condition)
• enotsock (condition)
• enotsup (condition)
• eprotonosupport (condition)
• errno (function)
• eterm (condition)
• getsockopt (function)
• libzmq-error (condition)
• msg-close (function)
• msg-copy (function)
• msg-data (function)
• msg-get (function)
• msg-init (function)
• msg-init-data (function)
• msg-init-size (function)
• msg-more (function)
• msg-move (function)
• msg-recv (function)
• msg-send (function)
• msg-set (function)
• msg-size (function)
• poll (function)
• proxy (function)
• recv-octets (function)
• recv-string (function)
• revents (function)
• send (function)
• setsockopt (function)
• socket (function)
• strerror (function)
• version (function)
• with-context (macro)
• with-message (macro)
• with-messages (macro)
• with-poll-items (macro)
• with-socket (macro)
• with-sockets (macro)

Internal Definitions

• %bind (function)
• %close (function)
• %connect (function)
• %ctx-destroy (function)
• %ctx-get (function)
• %ctx-set (function)
• %ctx-shutdown (function)
• %ctx-term (function)
• %curve-keypair (function)
• %device (function)
• %errno (function)
• %getsockopt (function)
• %msg-close (function)
• %msg-copy (function)
• %msg-get (function)
• %msg-init (function)
• %msg-init-data (function)
• %msg-init-size (function)
• %msg-more (function)
• %msg-move (function)
• %msg-recv (function)
• %msg-send (function)
• %msg-set (function)
• %msg-tclass (class)
• %poll (function)
• %proxy (function)
• %recv (function)
• %send (function)
• %setsockopt (function)
• %socket (function)
• %strerror (function)
• %version (function)
• +io-threads+ (constant)
• +max-sockets+ (constant)
• +more+ (constant)
• c-error-errno (generic function)
• c-error-errno (method)
• c-error-keyword (function)
• defcfun* (macro)
• define-conditions (macro)
• libzmq-error-condition (function)
• pollitem-tclass (class)
• size-of-%msg (constant)
• size-of-size (constant)
• with-c-error-check (macro)
• z85-decode (function)
• z85-encode (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *default-context*

Implicit context from @fun{WITH-CONTEXT} for @fun{WITH-SOCKET}.

Package

pzmq

Source

lisp-api.lisp (file)

Special Variable: *restart-interrupted-calls*

When blocking ZMQ call returns with EINTR automatically retry it, instead of signaling a condition.

Explanation: Every time garbage collection happens in implementation that use signals to stop threads (like SBCL), every ZMQ blocking ZMQ call, will error out with EINTR on every GC.

When this variable is non-NIL, PZMQ will retry the call, as if you had selected CONTINUE restart.

Note that EINTR will also be returned by any other interruptions such as attaching a debugger to a thread, or pressing Ctrl-C.

If you would like to terminate your ZMQ call in these cases, then rebind *RESTART-INTERRUPTED-CALLS*, and have a HANDLER-BIND set it to NIL on these special cases.

Then at a lower level, ignore EINTR errors. It is important to use HANDLER-BIND and not HANDLER-CASE, because we want the ZMQ function being interrupted to return EINTR, performing any necessary cleanups, using HANDLER-CASE or using non-local exit from HANDLER-BIND will accomplish its task, but without letting ZMQ call properly cleanup after itself.

Package

pzmq

Source

c-api.lisp (file)

5.1.2 Macros

Macro: with-context NAME-AND-OPTIONS &body BODY

Initialize and terminate ZMQ context around body.

Use NIL for @em{anonymous context}, stored in @variable{*DEFAULT-CONTEXT*}.

Omit @fun{WITH-CONTEXT} altogether, and @fun{WITH-SOCKET} will establish it by itself.

Note: unwind-protected @fun{CTX-TERM} will not return until all governed sockets have sent all queued messages, unless they limited their wait time with :LINGER socket parameter.
@arg[name-and-options]{name | (name options)}
@arg[name]{name | NIL}
@arg[options]{:io-threads INT :max-sockets INT; as per @fun{CTX-SET}}

Package

pzmq

Source

lisp-api.lisp (file)

Macro: with-message NAME &body BODY

Initialize and free ZMQ message around body.

Package

pzmq

Source

lisp-api.lisp (file)

Macro: with-messages (&rest NAMES) &body BODY

Package

pzmq

Source

lisp-api.lisp (file)

Macro: with-poll-items NAME (&rest ITEMS) &body BODY

Prepare POLLITEM array in NAME.

Without parentheses, an item indicates subscription to both :pollin and :pollout. @arg[items]{(item ...)}
@arg[item]{name | (name [:pollin] [:pollout])}

Package

pzmq

Source

lisp-api.lisp (file)

Macro: with-socket NAME-AND-CONTEXT TYPE-AND-OPTIONS &body BODY

Initialize and close ZMQ socket around body. Type is one of the types accepted by @fun{SOCKET}. Options are passed to @fun{SETSOCKOPT} one by one.

When TYPE is :SUB, and :SUBSCRIBE is not given in OPTIONS, imply subscribe to all. If this is undesirable, provide :SUBSCRIBE NIL.

When context is not specified, it either comes from surrounding @fun{WITH-CONTEXT} or @fun{WITH-SOCKET} in @variable{*DEFAULT-CONTEXT*}, or is established by this @fun{WITH-SOCKET} and stored in @variable{*DEFAULT-CONTEXT*} for the timespan of this block.
@arg[name-and-context]{name | (name context)}
@arg[type-and-options]{type | (type :option1 value1 :option2 value2 ...)}

Package

pzmq

Source

lisp-api.lisp (file)

Macro: with-sockets (&rest SOCKET-DEFINITIONS) &body BODY

Nest multiple sockets.

Package

pzmq

Source

lisp-api.lisp (file)

5.1.3 Functions

Function: bind SOCKET ENDPOINT

Accept connections on a socket.

Only one socket may be bound to a particular endpoint. Bound socket may receive messages sent before it was bound. @arg[endpoint]{"transport://address"}

Package

pzmq

Source

c-api.lisp (file)

Function: close SOCKET

Close ØMQ socket.

Package

pzmq

Source

c-api.lisp (file)

Function: connect SOCKET ENDPOINT

Connect a socket.

Many sockets may connect to the same endpoint.
Connected socket may not receive messages sent before it was bound. @arg[endpoint]{"transport://address"}

Package

pzmq

Source

c-api.lisp (file)

Function: ctx-destroy CONTEXT

Destroy a ØMQ context. Deprecated synonym for @see{CTX-TERM}

Package

pzmq

Source

c-api.lisp (file)

Function: ctx-get CONTEXT OPTION-NAME

@arg[option-name]{:io-threads | :max-threads} @see{CTX-SET} @return{integer}
Get context options.

Package

pzmq

Source

c-api.lisp (file)

Function: ctx-new ()

Create new ØMQ context. @see{CTX-TERM}

Package

pzmq

Source

c-api.lisp (file)

Function: ctx-set CONTEXT &key IO-THREADS MAX-SOCKETS

Set context options.

Package

pzmq

Source

c-api.lisp (file)

Function: ctx-shutdown CONTEXT

Shutdown a ØMQ context. Non-blocking. Optional before @see{CTX-TERM}

Package

pzmq

Source

c-api.lisp (file)

Function: ctx-term CONTEXT

Destroy a ØMQ context.

Package

pzmq

Source

c-api.lisp (file)

Function: curve-keypair ()

Generates and returns a CurveZMQ keypair.
@return{(VALUES PUBLIC-KEY SECRET-KEY), both of type (VECTOR (UNSIGNED-BYTE 8) 32).}

Package

pzmq

Source

c-api.lisp (file)

Function: device DEVICE FRONTEND BACKEND

Start built-in ØMQ device in the calling thread. Never returns unless interrupted. Deprecated by @fun{PROXY}
@arg[device]{:streamer | :forwarder | :queue}
@arg[frontend, backend]{socket}

Package

pzmq

Source

c-api.lisp (file)

Function: errno ()

Retrieve value of errno for the calling thread. @see{STRERROR}

Package

pzmq

Source

c-api.lisp (file)

Function: getsockopt SOCKET OPTION-NAME

Get ØMQ socket options.
@arg[option-name]{keyword}
@return{integer, or string for :identity and :last-endpoint}

Package

pzmq

Source

c-api.lisp (file)

Function: msg-close MSG

Release ØMQ message.

Low-level API. Consider using @fun{WITH-MESSAGE}.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-copy DEST SRC

Copy content of a message to another message.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-data MSG

Retrieve pointer to message content.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-get MSG PROPERTY

Get message property. The only defined property is :more; equivalent to @fun{MSG-MORE}. @arg[property]{:more}

Package

pzmq

Source

c-api.lisp (file)

Function: msg-init MSG

Initialise empty ØMQ message.

Low-level API. Consider using @fun{WITH-MESSAGE}. @see{MSG-CLOSE}
@see{MSG-INIT-SIZE}
@see{MSG-INIT-DATA}

Package

pzmq

Source

c-api.lisp (file)

Function: msg-init-data MSG DATA

Initialise ØMQ message from a supplied buffer. @see{MSG-CLOSE}
@see{MSG-INIT-SIZE}
@see{MSG-INIT-DATA}

Package

pzmq

Source

c-api.lisp (file)

Function: msg-init-size MSG SIZE

Initialise ØMQ message of a specified size. @see{MSG-CLOSE}
@see{MSG-INIT}
@see{MSG-INIT-DATA}

Package

pzmq

Source

c-api.lisp (file)

Function: msg-more MSG

Indicate if there are more message parts to receive.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-move DEST SRC

Move content of a message to another message.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-recv MSG SOCKET &key DONTWAIT

Receive a message part from a socket.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-send MSG SOCKET &key DONTWAIT SNDMORE

Send a message part on a socket.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-set MSG PROPERTY VALUE

Set message property. No setable properties defined yet.

Package

pzmq

Source

c-api.lisp (file)

Function: msg-size MSG

Retrieve message content size in bytes.

Package

pzmq

Source

c-api.lisp (file)

Function: poll ITEMS &optional TIMEOUT

Input/output multiplexing on ZeroMQ sockets. @arg[items]{Poll items prepared with @fun{WITH-POLL-ITEMS}} @arg[timeout]{-1 : wait indefinitely; N : wait N milliseconds} @return{The number of ready items.}

Package

pzmq

Source

c-api.lisp (file)

Function: proxy FRONTEND BACKEND CAPTURE

Start built-in ØMQ proxy in the current application thread. @arg[frontend, backend, capture]{socket}

Package

pzmq

Source

c-api.lisp (file)

Function: recv-octets SOCKET &key DONTWAIT

Receive a message part from a socket as an octet vector.
@return{A (vector (unsigned-byte 8)) as the primary value, and the value of the socket option :rcvmore as the secondary value.}

Package

pzmq

Source

lisp-api.lisp (file)

Function: recv-string SOCKET &key DONTWAIT ENCODING

Receive a message part from a socket as a string.
@return{A string as the primary value, and the value of the socket option :rcvmore as the secondary value.}

Package

pzmq

Source

lisp-api.lisp (file)

Function: revents ITEMS SUBSCRIPT

Return a list of events - :pollin, :pollout or both - that happened to an indicated item, counting from 0.
@return{([:pollin] [:pollout])}

Package

pzmq

Source

lisp-api.lisp (file)

Function: send SOCKET BUF &key LEN DONTWAIT SNDMORE ENCODING

Send a message part on a socket.

@arg[buf]{string, or foreign byte array, or byte array, or nil for an empty message} @arg[len]{ignored, or array size}

Package

pzmq

Source

c-api.lisp (file)

Function: setsockopt SOCKET OPTION-NAME OPTION-VALUE

Set ØMQ socket options.
Boolean options accept generalized Lisp booleans.
Binary options are supported either as strings or UB8 vectors.

Package

pzmq

Source

c-api.lisp (file)

Function: socket CONTEXT TYPE

Create ØMQ socket.
@arg[type]{:pair | :pub | :sub | :req | :rep | :dealer | :router | :pull | :push | :xpub | :xsub | :stream}

Package

pzmq

Source

c-api.lisp (file)

Function: strerror &optional ERRNUM

Get ØMQ error message string.

Package

pzmq

Source

c-api.lisp (file)

Function: version ()

@return{(major minor patch)}

Report ØMQ library version.

Package

pzmq

Source

c-api.lisp (file)

5.1.4 Conditions

Condition: c-error ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

libzmq-error (condition)

Direct methods

c-error-errno (method)

Direct slots

Slot: errno

Initargs

:errno

Readers

c-error-errno (generic function)

Condition: eaddrinuse ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: eaddrnotavail ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: eagain ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: efault ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: efsm ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: ehostunreach ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: eintr ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: einval ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: emfile ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: emthread ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: enocompatproto ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: enodev ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: enoent ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: enomem ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: enotsock ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: enotsup ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: eprotonosupport ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: eterm ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

libzmq-error (condition)

Condition: libzmq-error ()

Package

pzmq

Source

c-api.lisp (file)

Direct superclasses

c-error (condition)

Direct subclasses

• eaddrinuse (condition)
• eaddrnotavail (condition)
• eagain (condition)
• efault (condition)
• efsm (condition)
• ehostunreach (condition)
• eintr (condition)
• einval (condition)
• emfile (condition)
• emthread (condition)
• enocompatproto (condition)
• enodev (condition)
• enoent (condition)
• enomem (condition)
• enotsock (condition)
• enotsup (condition)
• eprotonosupport (condition)
• eterm (condition)

5.2 Internal definitions

5.2.1 Constants

Constant: +io-threads+

Package

pzmq

Source

c-api.lisp (file)

Constant: +max-sockets+

Package

pzmq

Source

c-api.lisp (file)

Constant: +more+

Package

pzmq

Source

c-api.lisp (file)

Constant: size-of-%msg

Package

pzmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/pzmq-20200610-git/grovel.processed-grovel-file

Constant: size-of-size

Package

pzmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/pzmq-20200610-git/grovel.processed-grovel-file

5.2.2 Macros

Macro: defcfun* NAME (RETURN-TYPE &optional ALLOW-RESTART) &body ARGS

Simple wrapper for DEFCFUN and DEFUN around WITH-POSIX-ERROR-CHECK.

Package

pzmq

Source

c-api.lisp (file)

Macro: define-conditions PARENT &rest CHILDREN

Package

pzmq

Source

c-api.lisp (file)

Macro: with-c-error-check (KIND &optional ALLOW-RESTART-P) &body BODY

Package

pzmq

Source

c-api.lisp (file)

5.2.3 Functions

Function: %bind SOCKET ENDPOINT

Accept connections on a socket.

Only one socket may be bound to a particular endpoint. Bound socket may receive messages sent before it was bound. @arg[endpoint]{"transport://address"}

Package

pzmq

Source

c-api.lisp (file)

Function: %close SOCKET

Close ØMQ socket.

Package

pzmq

Source

c-api.lisp (file)

Function: %connect SOCKET ENDPOINT

Connect a socket.

Many sockets may connect to the same endpoint.
Connected socket may not receive messages sent before it was bound. @arg[endpoint]{"transport://address"}

Package

pzmq

Source

c-api.lisp (file)

Function: %ctx-destroy CONTEXT

Destroy a ØMQ context. Deprecated synonym for @see{CTX-TERM}

Package

pzmq

Source

c-api.lisp (file)

Function: %ctx-get CONTEXT OPTION-NAME

Get context options.

Package

pzmq

Source

c-api.lisp (file)

Function: %ctx-set CONTEXT OPTION-NAME OPTION-VALUE

Set context options.

Package

pzmq

Source

c-api.lisp (file)

Function: %ctx-shutdown CONTEXT

Shutdown a ØMQ context. Non-blocking. Optional before @see{CTX-TERM}

Package

pzmq

Source

c-api.lisp (file)

Function: %ctx-term CONTEXT

Destroy a ØMQ context.

Package

pzmq

Source

c-api.lisp (file)

Function: %curve-keypair PUBLIC-KEY SECRET-KEY

Package

pzmq

Source

c-api.lisp (file)

Function: %device DEVICE FRONTEND BACKEND

Start built-in ØMQ device in the calling thread. Never returns unless interrupted. Deprecated by @fun{PROXY}
@arg[device]{:streamer | :forwarder | :queue}
@arg[frontend, backend]{socket}

Package

pzmq

Source

c-api.lisp (file)

Function: %errno ()

Retrieve value of errno for the calling thread.

Package

pzmq

Source

c-api.lisp (file)

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

Get ØMQ socket options.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-close MSG

Release ØMQ message.

Low-level API. Consider using @fun{WITH-MESSAGE}.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-copy DEST SRC

Copy content of a message to another message.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-get MSG PROPERTY

Get message property.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-init MSG

Initialise empty ØMQ message.

Low-level API. Consider using @fun{WITH-MESSAGE}. @see{MSG-CLOSE}
@see{MSG-INIT-SIZE}
@see{MSG-INIT-DATA}

Package

pzmq

Source

c-api.lisp (file)

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

Initialise ØMQ message from a supplied buffer.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-init-size MSG SIZE

Initialise ØMQ message of a specified size. @see{MSG-CLOSE}
@see{MSG-INIT}
@see{MSG-INIT-DATA}

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-more MSG

indicate if there are more message parts to receive.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-move DEST SRC

Move content of a message to another message.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-recv MSG SOCKET FLAGS

Receive a message part from a socket.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-send MSG SOCKET FLAGS

Send a message part on a socket.

Package

pzmq

Source

c-api.lisp (file)

Function: %msg-set MSG PROPERTY VALUE

Set message property. No setable properties defined yet.

Package

pzmq

Source

c-api.lisp (file)

Function: %poll ITEMS NITEMS TIMEOUT

Package

pzmq

Source

c-api.lisp (file)

Function: %proxy FRONTEND BACKEND CAPTURE

Start built-in ØMQ proxy in the current application thread. @arg[frontend, backend, capture]{socket}

Package

pzmq

Source

c-api.lisp (file)

Function: %recv SOCKET BUF LEN FLAGS

Receive a message part from a socket.

Package

pzmq

Source

c-api.lisp (file)

Function: %send SOCKET BUF LEN FLAGS

Send a message part on a socket.

Package

pzmq

Source

c-api.lisp (file)

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

Set ØMQ socket options.

Package

pzmq

Source

c-api.lisp (file)

Function: %socket CONTEXT TYPE

Create ØMQ socket.
@arg[type]{:pair | :pub | :sub | :req | :rep | :dealer | :router | :pull | :push | :xpub | :xsub | :stream}

Package

pzmq

Source

c-api.lisp (file)

Function: %strerror ERRNUM

Get ØMQ error message string.

Package

pzmq

Source

c-api.lisp (file)

Function: %version MAJOR MINOR PATCH

Report ØMQ library version.

Package

pzmq

Source

c-api.lisp (file)

Function: c-error-keyword ERRNO

Package

pzmq

Source

c-api.lisp (file)

Function: libzmq-error-condition ERRNO

Package

pzmq

Source

c-api.lisp (file)

Function: z85-decode DESTINATION STRING

Package

pzmq

Source

c-api.lisp (file)

Function: z85-encode DESTINATION DATA SIZE

Package

pzmq

Source

c-api.lisp (file)

5.2.4 Generic functions

Generic Function: c-error-errno CONDITION

Package

pzmq

Methods

Method: c-error-errno (CONDITION c-error)

Source

c-api.lisp (file)

5.2.5 Classes

Class: %msg-tclass ()

Package

pzmq

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/pzmq-20200610-git/grovel.processed-grovel-file

Direct superclasses

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

Class: pollitem-tclass ()

Package

pzmq

Source

c-api.lisp (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