The zeromq Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The zeromq Reference Manual

This is the zeromq Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:10:44 2022 GMT+0.

Table of Contents


1 Introduction

===============================================================================
cl-zmq
===============================================================================

Port of cl-zmq_ to 0mq 3, plus some general improvements. Additional aim is to
make interface lispier and more convinient to use and to add a comprehensive
test suite.

.. _cl-zmq: http://www.cliki.net/cl-zmq


2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 zeromq

Zero MQ 3 bindings

Maintainer

Mikhail Novikov <freiksenet@gmail.com>

Author

Vitaly Mayatskikh <v.mayatskih@gmail.com>

License

LGPLv3

Version

0.2.0

Dependencies
  • cffi (system).
  • trivial-garbage (system).
Source

zeromq.asd.

Child Component

src (module).


3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 zeromq/src

Source

zeromq.asd.

Parent Component

zeromq (system).

Child Components

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

4.1.1 zeromq/zeromq.asd

Source

zeromq.asd.

Parent Component

zeromq (system).

ASDF Systems

zeromq.


4.1.2 zeromq/src/package.lisp

Source

zeromq.asd.

Parent Component

src (module).

Packages

zeromq.


4.1.3 zeromq/src/grovel.lisp

Dependency

package.lisp (file).

Source

zeromq.asd.

Parent Component

src (module).


4.1.4 zeromq/src/meta.lisp

Dependency

grovel.lisp (file).

Source

zeromq.asd.

Parent Component

src (module).

Public Interface

zmq-error (condition).

Internals

4.1.5 zeromq/src/zeromq.lisp

Dependency

meta.lisp (file).

Source

zeromq.asd.

Parent Component

src (module).

Public Interface

proxy (function).

Internals

Previous: , Up: Lisp   [Contents][Index]

4.1.6 zeromq/src/zeromq-api.lisp

Dependency

zeromq.lisp (file).

Source

zeromq.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 zeromq

Source

package.lisp.

Nickname

zmq

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


6.1.1 Macros

Macro: with-context ((context) &body body)
Package

zeromq.

Source

zeromq-api.lisp.

Macro: with-socket ((socket context type) &body body)
Package

zeromq.

Source

zeromq-api.lisp.


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.2 Ordinary functions

Function: bind (s address)
Package

zeromq.

Source

zeromq-api.lisp.

Function: close (socket)
Package

zeromq.

Source

zeromq-api.lisp.

Function: connect (s address)
Package

zeromq.

Source

zeromq-api.lisp.

Function: ctx-destroy (context)
Package

zeromq.

Source

zeromq-api.lisp.

Function: ctx-get (context option)
Package

zeromq.

Source

zeromq-api.lisp.

Function: ctx-new ()
Package

zeromq.

Source

zeromq-api.lisp.

Function: ctx-set (context option value)
Package

zeromq.

Source

zeromq-api.lisp.

Function: disconnect (s address)
Package

zeromq.

Source

zeromq-api.lisp.

Function: getsockopt (socket option)
Package

zeromq.

Source

zeromq-api.lisp.

Function: make-msg (&key size data)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-close (msg)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-copy (dst src)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-data-as-array (msg)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-data-as-string (msg)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-move (dst src)
Package

zeromq.

Source

zeromq-api.lisp.

Reader: msg-raw (instance)
Writer: (setf msg-raw) (instance)
Package

zeromq.

Source

zeromq-api.lisp.

Target Slot

raw.

Function: msg-recv (s msg &rest flags)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-send (s msg &rest flags)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-size (msg)
Package

zeromq.

Source

zeromq-api.lisp.

Function: poll (sockets &optional timeout)
Package

zeromq.

Source

zeromq-api.lisp.

Function: proxy (frontend backend capture)
Package

zeromq.

Source

zeromq.lisp.

Function: recv (s length &rest flags)
Package

zeromq.

Source

zeromq-api.lisp.

Function: send (s data &rest flags)
Package

zeromq.

Source

zeromq-api.lisp.

Function: setsockopt (socket option value)
Package

zeromq.

Source

zeromq-api.lisp.

Function: socket (context type)
Package

zeromq.

Source

zeromq-api.lisp.

Function: unbind (s address)
Package

zeromq.

Source

zeromq-api.lisp.

Function: version ()
Package

zeromq.

Source

zeromq-api.lisp.


6.1.3 Conditions

Condition: zmq-error
Package

zeromq.

Source

meta.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

error-code.

Writers

This slot is read-only.

Slot: description
Initargs

:description

Readers

error-description.

Writers

This slot is read-only.


Previous: , Up: Public Interface   [Contents][Index]

6.1.4 Structures

Structure: msg
Package

zeromq.

Source

zeromq-api.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: raw
Readers

msg-raw.

Writers

(setf msg-raw).


6.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.1 Macros

Macro: with-zmq-string (args &body body)
Package

zeromq.

Source

meta.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.2 Ordinary functions

Function: %%msg-init-data (msg data size ffn hint)
Package

zeromq.

Source

zeromq.lisp.

Function: %bind (socket endpoint)
Package

zeromq.

Source

zeromq.lisp.

Function: %close (socket)
Package

zeromq.

Source

zeromq.lisp.

Function: %connect (socket endpoint)
Package

zeromq.

Source

zeromq.lisp.

Function: %ctx-destroy (context)
Package

zeromq.

Source

zeromq.lisp.

Function: %ctx-get (context option-name)
Package

zeromq.

Source

zeromq.lisp.

Function: %ctx-new ()
Package

zeromq.

Source

zeromq.lisp.

Function: %ctx-set (context option-name option-value)
Package

zeromq.

Source

zeromq.lisp.

Function: %disconnect (socket endpoint)
Package

zeromq.

Source

zeromq.lisp.

Function: %errno ()
Package

zeromq.

Source

zeromq.lisp.

Function: %getsockopt (socket option-name option-value option-len)
Package

zeromq.

Source

zeromq.lisp.

Function: %make-msg (&key raw)
Package

zeromq.

Source

zeromq-api.lisp.

Function: %memcpy (dst src len)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-close (msg)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-copy (dest src)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-data (msg)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-get (msg property)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-init (msg)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-init-size (msg size)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-more (msg)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-move (dest src)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-recv (msg socket flags)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-send (msg socket flags)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-set (msg property value)
Package

zeromq.

Source

zeromq.lisp.

Function: %msg-size (msg)
Package

zeromq.

Source

zeromq.lisp.

Function: %poll (items nitems timeout)
Package

zeromq.

Source

zeromq.lisp.

Function: %recv (socket data size flags)
Package

zeromq.

Source

zeromq.lisp.

Function: %send (socket data size flags)
Package

zeromq.

Source

zeromq.lisp.

Function: %setsockopt (socket option-name option-value optvallen)
Package

zeromq.

Source

zeromq.lisp.

Function: %socket (context type)
Package

zeromq.

Source

zeromq.lisp.

Function: %strerror (errnum)
Package

zeromq.

Source

zeromq.lisp.

Function: %unbind (socket endpoint)
Package

zeromq.

Source

zeromq.lisp.

Function: %version (major minor patch)
Package

zeromq.

Source

zeromq.lisp.

Function: %zmq-init-data (msg data size)
Package

zeromq.

Source

zeromq.lisp.

Function: call-with-error-check (function args &key type error-p)
Package

zeromq.

Source

meta.lisp.

Function: copy-lisp-string-octets (string alloc-fn &key encoding start end)

Allocate a foreign string containing Lisp string STRING. The string must be freed with FOREIGN-STRING-FREE.

Package

zeromq.

Source

meta.lisp.

Function: copy-msg (instance)
Package

zeromq.

Source

zeromq-api.lisp.

Function: extract-pollitem-events (pollitem)
Package

zeromq.

Source

zeromq-api.lisp.

Function: extract-pollitems-events (pollitems length)
Package

zeromq.

Source

zeromq-api.lisp.

Function: fill-pollitem (pollitem s &rest flags)
Package

zeromq.

Source

zeromq-api.lisp.

Function: get-socket-option-value-type (option)
Package

zeromq.

Source

zeromq-api.lisp.

Function: msg-p (object)
Package

zeromq.

Source

zeromq-api.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.3 Generic functions

Generic Reader: error-code (condition)
Package

zeromq.

Methods
Reader Method: error-code ((condition zmq-error))
Source

meta.lisp.

Target Slot

code.

Generic Reader: error-description (condition)
Package

zeromq.

Methods
Reader Method: error-description ((condition zmq-error))
Source

meta.lisp.

Target Slot

description.


Previous: , Up: Internals   [Contents][Index]

6.2.4 Classes

Class: c-msg-tclass
Package

zeromq.

Source

zeromq.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: c-pollitem-tclass
Package

zeromq.

Source

zeromq.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
B   C   D   E   F   G   M   P   R   S   U   V   W  
Index Entry  Section

%
%%msg-init-data: Private ordinary functions
%bind: Private ordinary functions
%close: Private ordinary functions
%connect: Private ordinary functions
%ctx-destroy: Private ordinary functions
%ctx-get: Private ordinary functions
%ctx-new: Private ordinary functions
%ctx-set: Private ordinary functions
%disconnect: Private ordinary functions
%errno: Private ordinary functions
%getsockopt: Private ordinary functions
%make-msg: Private ordinary functions
%memcpy: Private ordinary functions
%msg-close: Private ordinary functions
%msg-copy: Private ordinary functions
%msg-data: Private ordinary functions
%msg-get: Private ordinary functions
%msg-init: Private ordinary functions
%msg-init-size: Private ordinary functions
%msg-more: Private ordinary functions
%msg-move: Private ordinary functions
%msg-recv: Private ordinary functions
%msg-send: Private ordinary functions
%msg-set: Private ordinary functions
%msg-size: Private ordinary functions
%poll: Private ordinary functions
%recv: Private ordinary functions
%send: Private ordinary functions
%setsockopt: Private ordinary functions
%socket: Private ordinary functions
%strerror: Private ordinary functions
%unbind: Private ordinary functions
%version: Private ordinary functions
%zmq-init-data: Private ordinary functions

(
(setf msg-raw): Public ordinary functions

B
bind: Public ordinary functions

C
call-with-error-check: Private ordinary functions
close: Public ordinary functions
connect: Public ordinary functions
copy-lisp-string-octets: Private ordinary functions
copy-msg: Private ordinary functions
ctx-destroy: Public ordinary functions
ctx-get: Public ordinary functions
ctx-new: Public ordinary functions
ctx-set: Public ordinary functions

D
disconnect: Public ordinary functions

E
error-code: Private generic functions
error-code: Private generic functions
error-description: Private generic functions
error-description: Private generic functions
extract-pollitem-events: Private ordinary functions
extract-pollitems-events: Private ordinary functions

F
fill-pollitem: Private ordinary functions
Function, %%msg-init-data: Private ordinary functions
Function, %bind: Private ordinary functions
Function, %close: Private ordinary functions
Function, %connect: Private ordinary functions
Function, %ctx-destroy: Private ordinary functions
Function, %ctx-get: Private ordinary functions
Function, %ctx-new: Private ordinary functions
Function, %ctx-set: Private ordinary functions
Function, %disconnect: Private ordinary functions
Function, %errno: Private ordinary functions
Function, %getsockopt: Private ordinary functions
Function, %make-msg: Private ordinary functions
Function, %memcpy: Private ordinary functions
Function, %msg-close: Private ordinary functions
Function, %msg-copy: Private ordinary functions
Function, %msg-data: Private ordinary functions
Function, %msg-get: Private ordinary functions
Function, %msg-init: Private ordinary functions
Function, %msg-init-size: Private ordinary functions
Function, %msg-more: Private ordinary functions
Function, %msg-move: Private ordinary functions
Function, %msg-recv: Private ordinary functions
Function, %msg-send: Private ordinary functions
Function, %msg-set: Private ordinary functions
Function, %msg-size: Private ordinary functions
Function, %poll: Private ordinary functions
Function, %recv: Private ordinary functions
Function, %send: Private ordinary functions
Function, %setsockopt: Private ordinary functions
Function, %socket: Private ordinary functions
Function, %strerror: Private ordinary functions
Function, %unbind: Private ordinary functions
Function, %version: Private ordinary functions
Function, %zmq-init-data: Private ordinary functions
Function, (setf msg-raw): Public ordinary functions
Function, bind: Public ordinary functions
Function, call-with-error-check: Private ordinary functions
Function, close: Public ordinary functions
Function, connect: Public ordinary functions
Function, copy-lisp-string-octets: Private ordinary functions
Function, copy-msg: Private ordinary functions
Function, ctx-destroy: Public ordinary functions
Function, ctx-get: Public ordinary functions
Function, ctx-new: Public ordinary functions
Function, ctx-set: Public ordinary functions
Function, disconnect: Public ordinary functions
Function, extract-pollitem-events: Private ordinary functions
Function, extract-pollitems-events: Private ordinary functions
Function, fill-pollitem: Private ordinary functions
Function, get-socket-option-value-type: Private ordinary functions
Function, getsockopt: Public ordinary functions
Function, make-msg: Public ordinary functions
Function, msg-close: Public ordinary functions
Function, msg-copy: Public ordinary functions
Function, msg-data-as-array: Public ordinary functions
Function, msg-data-as-string: Public ordinary functions
Function, msg-move: Public ordinary functions
Function, msg-p: Private ordinary functions
Function, msg-raw: Public ordinary functions
Function, msg-recv: Public ordinary functions
Function, msg-send: Public ordinary functions
Function, msg-size: Public ordinary functions
Function, poll: Public ordinary functions
Function, proxy: Public ordinary functions
Function, recv: Public ordinary functions
Function, send: Public ordinary functions
Function, setsockopt: Public ordinary functions
Function, socket: Public ordinary functions
Function, unbind: Public ordinary functions
Function, version: Public ordinary functions

G
Generic Function, error-code: Private generic functions
Generic Function, error-description: Private generic functions
get-socket-option-value-type: Private ordinary functions
getsockopt: Public ordinary functions

M
Macro, with-context: Public macros
Macro, with-socket: Public macros
Macro, with-zmq-string: Private macros
make-msg: Public ordinary functions
Method, error-code: Private generic functions
Method, error-description: Private generic functions
msg-close: Public ordinary functions
msg-copy: Public ordinary functions
msg-data-as-array: Public ordinary functions
msg-data-as-string: Public ordinary functions
msg-move: Public ordinary functions
msg-p: Private ordinary functions
msg-raw: Public ordinary functions
msg-recv: Public ordinary functions
msg-send: Public ordinary functions
msg-size: Public ordinary functions

P
poll: Public ordinary functions
proxy: Public ordinary functions

R
recv: Public ordinary functions

S
send: Public ordinary functions
setsockopt: Public ordinary functions
socket: Public ordinary functions

U
unbind: Public ordinary functions

V
version: Public ordinary functions

W
with-context: Public macros
with-socket: Public macros
with-zmq-string: Private macros

Jump to:   %   (  
B   C   D   E   F   G   M   P   R   S   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   C   D   R   S  
Index Entry  Section

C
code: Public conditions

D
description: Public conditions

R
raw: Public structures

S
Slot, code: Public conditions
Slot, description: Public conditions
Slot, raw: Public structures

Jump to:   C   D   R   S