The cl-zmq Reference Manual

Table of Contents

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

The cl-zmq Reference Manual

This is the cl-zmq Reference Manual, version 0.2.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:37:53 2018 GMT+0.


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

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


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

2 Systems

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


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

2.1 zeromq

Maintainer

Mikhail Novikov <freiksenet@gmail.com>

Author

Vitaly Mayatskikh <v.mayatskih@gmail.com>

License

LGPLv3

Description

Zero MQ 3 bindings

Version

0.2.0

Dependencies
Source

zeromq.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 zeromq/src

Parent

zeromq (system)

Location

src/

Components

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

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 files   [Contents][Index]

4.1.1 zeromq.asd

Location

zeromq.asd

Systems

zeromq (system)


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

4.1.2 zeromq/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

zeromq


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

4.1.3 zeromq/src/grovel.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/grovel.lisp


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

4.1.4 zeromq/src/meta.lisp

Dependency

grovel.lisp (file)

Parent

src (module)

Location

src/meta.lisp

Exported Definitions

zmq-error (condition)

Internal Definitions

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

4.1.5 zeromq/src/zeromq.lisp

Dependency

meta.lisp (file)

Parent

src (module)

Location

src/zeromq.lisp

Exported Definitions

proxy (function)

Internal Definitions

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

4.1.6 zeromq/src/zeromq-api.lisp

Dependency

zeromq.lisp (file)

Parent

src (module)

Location

src/zeromq-api.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 zeromq

Source

package.lisp (file)

Nickname

zmq

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

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

zeromq

Source

zeromq-api.lisp (file)

Macro: with-socket (SOCKET CONTEXT TYPE) &body BODY
Package

zeromq

Source

zeromq-api.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: bind S ADDRESS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: close SOCKET
Package

zeromq

Source

zeromq-api.lisp (file)

Function: connect S ADDRESS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: ctx-destroy CONTEXT
Package

zeromq

Source

zeromq-api.lisp (file)

Function: ctx-get CONTEXT OPTION
Package

zeromq

Source

zeromq-api.lisp (file)

Function: ctx-new ()
Package

zeromq

Source

zeromq-api.lisp (file)

Function: ctx-set CONTEXT OPTION VALUE
Package

zeromq

Source

zeromq-api.lisp (file)

Function: disconnect S ADDRESS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: getsockopt SOCKET OPTION
Package

zeromq

Source

zeromq-api.lisp (file)

Function: make-msg &key SIZE DATA
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-close MSG
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-copy DST SRC
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-data-as-array MSG
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-data-as-string MSG
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-move DST SRC
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-raw INSTANCE
Function: (setf msg-raw) VALUE INSTANCE
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-recv S MSG &rest FLAGS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-send S MSG &rest FLAGS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-size MSG
Package

zeromq

Source

zeromq-api.lisp (file)

Function: poll SOCKETS &optional TIMEOUT
Package

zeromq

Source

zeromq-api.lisp (file)

Function: proxy FRONTEND BACKEND CAPTURE
Package

zeromq

Source

zeromq.lisp (file)

Function: recv S LENGTH &rest FLAGS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: send S DATA &rest FLAGS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: setsockopt SOCKET OPTION VALUE
Package

zeromq

Source

zeromq-api.lisp (file)

Function: socket CONTEXT TYPE
Package

zeromq

Source

zeromq-api.lisp (file)

Function: unbind S ADDRESS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: version ()
Package

zeromq

Source

zeromq-api.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Conditions

Condition: zmq-error ()
Package

zeromq

Source

meta.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

error-code (generic function)

Slot: description
Initargs

:description

Readers

error-description (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Structures

Structure: msg ()
Package

zeromq

Source

zeromq-api.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: raw
Readers

msg-raw (function)

Writers

(setf msg-raw) (function)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

Constant: size-of-size-t
Package

zeromq

Source

/home/quickbuilder/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickbuilder/quicklisp/dists/quicklisp/software/cl-zmq-20160318-git/src/grovel.processed-grovel-file


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: with-zmq-string ARGS &body BODY
Package

zeromq

Source

meta.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

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

zeromq

Source

zeromq.lisp (file)

Function: %bind SOCKET ENDPOINT
Package

zeromq

Source

zeromq.lisp (file)

Function: %close SOCKET
Package

zeromq

Source

zeromq.lisp (file)

Function: %connect SOCKET ENDPOINT
Package

zeromq

Source

zeromq.lisp (file)

Function: %ctx-destroy CONTEXT
Package

zeromq

Source

zeromq.lisp (file)

Function: %ctx-get CONTEXT OPTION-NAME
Package

zeromq

Source

zeromq.lisp (file)

Function: %ctx-new ()
Package

zeromq

Source

zeromq.lisp (file)

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

zeromq

Source

zeromq.lisp (file)

Function: %disconnect SOCKET ENDPOINT
Package

zeromq

Source

zeromq.lisp (file)

Function: %errno ()
Package

zeromq

Source

zeromq.lisp (file)

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

zeromq

Source

zeromq.lisp (file)

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

zeromq

Source

zeromq-api.lisp (file)

Function: %memcpy DST SRC LEN
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-close MSG
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-copy DEST SRC
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-data MSG
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-get MSG PROPERTY
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-init MSG
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-init-size MSG SIZE
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-more MSG
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-move DEST SRC
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-recv MSG SOCKET FLAGS
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-send MSG SOCKET FLAGS
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-set MSG PROPERTY VALUE
Package

zeromq

Source

zeromq.lisp (file)

Function: %msg-size MSG
Package

zeromq

Source

zeromq.lisp (file)

Function: %poll ITEMS NITEMS TIMEOUT
Package

zeromq

Source

zeromq.lisp (file)

Function: %recv SOCKET DATA SIZE FLAGS
Package

zeromq

Source

zeromq.lisp (file)

Function: %send SOCKET DATA SIZE FLAGS
Package

zeromq

Source

zeromq.lisp (file)

Function: %setsockopt SOCKET OPTION-NAME OPTION-VALUE OPTVALLEN
Package

zeromq

Source

zeromq.lisp (file)

Function: %socket CONTEXT TYPE
Package

zeromq

Source

zeromq.lisp (file)

Function: %strerror ERRNUM
Package

zeromq

Source

zeromq.lisp (file)

Function: %unbind SOCKET ENDPOINT
Package

zeromq

Source

zeromq.lisp (file)

Function: %version MAJOR MINOR PATCH
Package

zeromq

Source

zeromq.lisp (file)

Function: %zmq-init-data MSG DATA SIZE
Package

zeromq

Source

zeromq.lisp (file)

Function: call-with-error-check FUNCTION ARGS &key TYPE ERROR-P
Package

zeromq

Source

meta.lisp (file)

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 (file)

Function: copy-msg INSTANCE
Package

zeromq

Source

zeromq-api.lisp (file)

Function: extract-pollitem-events POLLITEM
Package

zeromq

Source

zeromq-api.lisp (file)

Function: extract-pollitems-events POLLITEMS LENGTH
Package

zeromq

Source

zeromq-api.lisp (file)

Function: fill-pollitem POLLITEM S &rest FLAGS
Package

zeromq

Source

zeromq-api.lisp (file)

Function: get-socket-option-value-type OPTION
Package

zeromq

Source

zeromq-api.lisp (file)

Function: msg-p OBJECT
Package

zeromq

Source

zeromq-api.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: error-code CONDITION
Package

zeromq

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

meta.lisp (file)

Generic Function: error-description CONDITION
Package

zeromq

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

meta.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Classes

Class: c-msg-tclass ()
Package

zeromq

Source

zeromq.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: c-pollitem-tclass ()
Package

zeromq

Source

zeromq.lisp (file)

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

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   Z  
Index Entry  Section

F
File, Lisp, zeromq.asd: The zeromq<dot>asd file
File, Lisp, zeromq/src/grovel.lisp: The zeromq/src/grovel<dot>lisp file
File, Lisp, zeromq/src/meta.lisp: The zeromq/src/meta<dot>lisp file
File, Lisp, zeromq/src/package.lisp: The zeromq/src/package<dot>lisp file
File, Lisp, zeromq/src/zeromq-api.lisp: The zeromq/src/zeromq-api<dot>lisp file
File, Lisp, zeromq/src/zeromq.lisp: The zeromq/src/zeromq<dot>lisp file

L
Lisp File, zeromq.asd: The zeromq<dot>asd file
Lisp File, zeromq/src/grovel.lisp: The zeromq/src/grovel<dot>lisp file
Lisp File, zeromq/src/meta.lisp: The zeromq/src/meta<dot>lisp file
Lisp File, zeromq/src/package.lisp: The zeromq/src/package<dot>lisp file
Lisp File, zeromq/src/zeromq-api.lisp: The zeromq/src/zeromq-api<dot>lisp file
Lisp File, zeromq/src/zeromq.lisp: The zeromq/src/zeromq<dot>lisp file

M
Module, zeromq/src: The zeromq/src module

Z
zeromq.asd: The zeromq<dot>asd file
zeromq/src: The zeromq/src module
zeromq/src/grovel.lisp: The zeromq/src/grovel<dot>lisp file
zeromq/src/meta.lisp: The zeromq/src/meta<dot>lisp file
zeromq/src/package.lisp: The zeromq/src/package<dot>lisp file
zeromq/src/zeromq-api.lisp: The zeromq/src/zeromq-api<dot>lisp file
zeromq/src/zeromq.lisp: The zeromq/src/zeromq<dot>lisp file

Jump to:   F   L   M   Z  

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: Internal functions
%bind: Internal functions
%close: Internal functions
%connect: Internal functions
%ctx-destroy: Internal functions
%ctx-get: Internal functions
%ctx-new: Internal functions
%ctx-set: Internal functions
%disconnect: Internal functions
%errno: Internal functions
%getsockopt: Internal functions
%make-msg: Internal functions
%memcpy: Internal functions
%msg-close: Internal functions
%msg-copy: Internal functions
%msg-data: Internal functions
%msg-get: Internal functions
%msg-init: Internal functions
%msg-init-size: Internal functions
%msg-more: Internal functions
%msg-move: Internal functions
%msg-recv: Internal functions
%msg-send: Internal functions
%msg-set: Internal functions
%msg-size: Internal functions
%poll: Internal functions
%recv: Internal functions
%send: Internal functions
%setsockopt: Internal functions
%socket: Internal functions
%strerror: Internal functions
%unbind: Internal functions
%version: Internal functions
%zmq-init-data: Internal functions

(
(setf msg-raw): Exported functions

B
bind: Exported functions

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

D
disconnect: Exported functions

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

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

G
Generic Function, error-code: Internal generic functions
Generic Function, error-description: Internal generic functions
get-socket-option-value-type: Internal functions
getsockopt: Exported functions

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

P
poll: Exported functions
proxy: Exported functions

R
recv: Exported functions

S
send: Exported functions
setsockopt: Exported functions
socket: Exported functions

U
unbind: Exported functions

V
version: Exported functions

W
with-context: Exported macros
with-socket: Exported macros
with-zmq-string: Internal 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: Exported conditions
Constant, size-of-size-t: Internal constants

D
description: Exported conditions

R
raw: Exported structures

S
size-of-size-t: Internal constants
Slot, code: Exported conditions
Slot, description: Exported conditions
Slot, raw: Exported structures

Jump to:   C   D   R   S  

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

A.4 Data types

Jump to:   C   M   P   S   Z  
Index Entry  Section

C
c-msg-tclass: Internal classes
c-pollitem-tclass: Internal classes
Class, c-msg-tclass: Internal classes
Class, c-pollitem-tclass: Internal classes
Condition, zmq-error: Exported conditions

M
msg: Exported structures

P
Package, zeromq: The zeromq package

S
Structure, msg: Exported structures
System, zeromq: The zeromq system

Z
zeromq: The zeromq system
zeromq: The zeromq package
zmq-error: Exported conditions

Jump to:   C   M   P   S   Z