The cl-rabbit Reference Manual

4.1.1 cl-rabbit/cl-rabbit.asd

Source

cl-rabbit.asd.

Parent Component

cl-rabbit (system).

ASDF Systems

cl-rabbit.

---

4.1.2 cl-rabbit/src/package.lisp

Source

cl-rabbit.asd.

Parent Component

src (module).

Packages

• cl-rabbit.
• cl-rabbit.examples.

---

4.1.3 cl-rabbit/src/grovel.lisp

Dependency

package.lisp (file).

Source

cl-rabbit.asd.

Parent Component

src (module).

---

4.1.4 cl-rabbit/src/functions.lisp

Dependency

grovel.lisp (file).

Source

cl-rabbit.asd.

Parent Component

src (module).

Internals

• amqp-basic-ack (function).
• amqp-basic-cancel (function).
• amqp-basic-consume (function).
• amqp-basic-get (function).
• amqp-basic-nack (function).
• amqp-basic-publish (function).
• amqp-basic-qos (function).
• amqp-basic-reject (function).
• amqp-channel-close (function).
• amqp-channel-flow (function).
• amqp-channel-open (function).
• amqp-confirm-select (function).
• amqp-connection-close (function).
• amqp-consume-message (function).
• amqp-cstring-bytes (function).
• amqp-data-in-buffer (function).
• amqp-destroy-connection (function).
• amqp-destroy-envelope (function).
• amqp-error-string2 (function).
• amqp-exchange-bind (function).
• amqp-exchange-declare-0-5 (function).
• amqp-exchange-declare-0-6 (function).
• amqp-exchange-delete (function).
• amqp-exchange-unbind (function).
• amqp-frames-enqueued (function).
• amqp-get-rpc-reply (function).
• amqp-get-sockfd (function).
• amqp-login-sasl-plain (function).
• amqp-login-sasl-plain-with-properties (function).
• amqp-maybe-release-buffers (function).
• amqp-maybe-release-buffers-on-channel (function).
• amqp-new-connection (function).
• amqp-queue-bind (function).
• amqp-queue-declare (function).
• amqp-queue-delete (function).
• amqp-queue-purge (function).
• amqp-queue-unbind (function).
• amqp-send-frame (function).
• amqp-send-method (function).
• amqp-set-initialize-ssl-library (function).
• amqp-simple-wait-frame (function).
• amqp-simple-wait-frame-noblock (function).
• amqp-socket-get-sockfd (function).
• amqp-socket-open (function).
• amqp-ssl-socket-new (function).
• amqp-ssl-socket-set-cacert (function).
• amqp-ssl-socket-set-key (function).
• amqp-ssl-socket-set-key-buffer (function).
• amqp-ssl-socket-set-verify (function).
• amqp-tcp-socket-new (function).
• amqp-tcp-socket-set-sockfd (function).
• amqp-tx-commit (function).
• amqp-tx-rollback (function).
• amqp-tx-select (function).
• amqp-version (function).

---

4.1.5 cl-rabbit/src/misc.lisp

Dependency

functions.lisp (file).

Source

cl-rabbit.asd.

Parent Component

src (module).

Internals

• *field-kind-types* (special variable).
• allocate-amqp-table (function).
• amqp-table->lisp (function).
• array-to-foreign-char-array (function).
• bytes->array (function).
• bytes->string (function).
• bzero-ptr (function).
• call-with-amqp-table (function).
• call-with-timeval (function).
• convert-to-bytes (function).
• print-unreadable-safely (macro).
• typed-value->lisp (function).
• unwind-when-fail (macro).
• with-amqp-table (macro).
• with-bytes-string (macro).
• with-bytes-strings (macro).
• with-bytes-struct (macro).
• with-foreign-buffer-from-byte-array (macro).
• with-foreign-timeval (macro).

---

4.1.6 cl-rabbit/src/amqp.lisp

Dependency

misc.lisp (file).

Source

cl-rabbit.asd.

Parent Component

src (module).

Public Interface

• basic-ack (function).
• basic-cancel (function).
• basic-consume (function).
• basic-nack (function).
• basic-publish (function).
• basic-qos (function).
• channel-close (function).
• channel-flow (function).
• channel-open (function).
• confirm-select (function).
• consume-message (function).
• content-body-frame (class).
• content-body-frame/body (reader method).
• content-body-frame/channel (reader method).
• content-header-frame (class).
• content-header-frame/body-size (reader method).
• content-header-frame/channel (reader method).
• content-header-frame/class-id (reader method).
• content-header-frame/properties (reader method).
• destroy-connection (function).
• envelope (class).
• envelope/channel (reader method).
• envelope/consumer-tag (reader method).
• envelope/delivery-tag (reader method).
• envelope/exchange (reader method).
• envelope/message (reader method).
• envelope/routing-key (reader method).
• exchange-bind (function).
• exchange-declare (function).
• exchange-delete (function).
• exchange-unbind (function).
• login-sasl-plain (function).
• message (class).
• message/body (reader method).
• message/properties (reader method).
• method-frame-basic-acknowledgment (class).
• method-frame-basic-acknowledgment/channel (reader method).
• method-frame-basic-acknowledgment/delivery-tag (reader method).
• method-frame-basic-acknowledgment/id (reader method).
• method-frame-basic-acknowledgment/multiplep (reader method).
• method-frame-basic-deliver (class).
• method-frame-basic-deliver/channel (reader method).
• method-frame-basic-deliver/consumer-tag (reader method).
• method-frame-basic-deliver/delivery-tag (reader method).
• method-frame-basic-deliver/exchange (reader method).
• method-frame-basic-deliver/id (reader method).
• method-frame-basic-deliver/redeliveredp (reader method).
• method-frame-basic-deliver/routing-key (reader method).
• method-frame-basic-negative-acknowledgment (class).
• method-frame-basic-negative-acknowledgment/channel (reader method).
• method-frame-basic-negative-acknowledgment/id (reader method).
• method-frame-basic-negative-acknowledgment/multiplep (reader method).
• method-frame-basic-negative-acknowledgment/requeuep (reader method).
• method-frame-basic-return (class).
• method-frame-basic-return/channel (reader method).
• method-frame-basic-return/exchange (reader method).
• method-frame-basic-return/id (reader method).
• method-frame-basic-return/reply-code (reader method).
• method-frame-basic-return/reply-text (reader method).
• method-frame-basic-return/routing-key (reader method).
• method-frame-error (condition).
• method-frame-error/channel (reader method).
• method-frame-error/method-id (reader method).
• new-connection (function).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• queue-bind (function).
• queue-declare (function).
• queue-delete (function).
• queue-purge (function).
• queue-unbind (function).
• rabbitmq-error (condition).
• rabbitmq-library-error (condition).
• rabbitmq-library-error/error-code (reader method).
• rabbitmq-library-error/error-description (reader method).
• rabbitmq-server-error (condition).
• rabbitmq-server-error/message (reader method).
• rabbitmq-server-error/reply-code (reader method).
• set-init-ssl-library (function).
• simple-wait-frame (function).
• socket-open (function).
• ssl-socket-new (function).
• ssl-socket-set-cacert (function).
• ssl-socket-set-key (function).
• ssl-socket-set-key-buffer (function).
• ssl-socket-set-verify (function).
• tcp-socket-new (function).
• tx-commit (function).
• tx-rollback (function).
• tx-select (function).
• version (function).
• with-channel (macro).
• with-connection (macro).

Internals

• %check-client-version (function).
• *props-mapping* (special variable).
• check-client-version (function).
• confirm-channel-close (function).
• connection (class).
• connection-close (function).
• connection/closed-p (reader method).
• (setf connection/closed-p) (writer method).
• connection/native-connection (reader method).
• data-in-buffer (function).
• fail-if-null (function).
• fill-in-properties-alist (function).
• foreign-method->class (method).
• foreign-method->class (method).
• foreign-method->class (method).
• foreign-method->class (method).
• foreign-method->class (method).
• frames-enqueued (function).
• get-sockfd (function).
• load-properties-to-alist (function).
• make-content-body-frame (function).
• make-content-header-frame (function).
• make-envelope-message (function).
• make-method-frame-basic-acknowledgment (function).
• make-method-frame-basic-deliver (function).
• make-method-frame-basic-negative-acknowledgment (function).
• make-method-frame-basic-return (function).
• maybe-release-buffers (function).
• method-frame (class).
• method-frame-basic-negative-acknowledgment/delivery-tag (reader method).
• method-frame/channel (reader method).
• method-frame/id (reader method).
• rabbitmq-server-error/method (reader method).
• raise-method-frame-error (function).
• raise-rabbitmq-library-error (function).
• raise-rabbitmq-server-error (function).
• update-product-name-in-table (function).
• verify-rpc-framing-call (function).
• verify-rpc-reply (function).
• verify-status (function).
• with-state (macro).

---

6.1.1 Macros

Macro: with-channel ((connection channel) &body body) ¶

Opens CHANNEL, evaluates BODY and ensures you don’t leave without closing the channel

Package

cl-rabbit.

Source

amqp.lisp.

Macro: with-connection ((conn) &body body) ¶

Creates a connection using NEW-CONNECTION and evaluates BODY with the connection bound to CONN.

Package

cl-rabbit.

Source

amqp.lisp.

---

6.1.2 Ordinary functions

Function: basic-ack (conn channel delivery-tag &key multiple) ¶

Acknowledges a message.
Does a basic.ack on a received message.

Parameters:
CONN - the connection object
CHANNEL - the channel identifier
MULTIPLE - if true, ack all messages up to this delivery tag, if false ack only this delivery tag

Package

cl-rabbit.

Source

amqp.lisp.

Function: basic-cancel (conn channel consumer-tag) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: basic-consume (conn channel queue &key consumer-tag no-local no-ack exclusive arguments) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: basic-nack (conn channel delivery-tag &key multiple requeue) ¶

Do a basic.nack.
Actively reject a message, this has the same effect as amqp_basic_reject() however, amqp_basic_nack() can negatively acknowledge multiple messages with
one call much like amqp_basic_ack() can acknowledge mutliple messages with
one call.

Parameters:
CONN - the connection object
CHANNEL - the channel identifier
DELIVERY-TAG - the delivery tag of the message to reject
MULTIPLE - if true negatively acknowledge all unacknowledged messages on this channel REQUEUE - indicate to the broker whether it should requeue the message

Package

cl-rabbit.

Source

amqp.lisp.

Function: basic-publish (conn channel &key exchange routing-key mandatory immediate properties body encoding) ¶

Publish a message on an exchange with a routing key.
Note that at the AMQ protocol level basic.publish is an async method:
this means error conditions that occur on the broker (such as
publishing to a non-existent exchange) will not be reflected in the
return value of this function.

Parameters:

CONN - the connection on which to send the message.

CHANNEL - the channel that should be used.

EXCHANGE - the exchange on the broker to publish to

ROUTING-KEY - the routing key to use when publishing the message

MANDATORY - indicate to the broker that the message MUST be routed to
a queue. If the broker cannot do this it should respond with a
basic.reject method

IMMEDIATE - indicate to the broker that the message MUST be delivered
to a consumer immediately. If the broker cannot do this it should
response with a basic.reject method.

BODY - can be either a vector of bytes, or a string. If it’s a string,
then it will be encoded using ENCODING before sending.

PROPERTIES - indicates an alist of message properties. The
following property keywords are accepted:
:CONTENT-TYPE :CONTENT-ENCODING :DELIVERY-MODE :PRIORITY :CORRELATION-ID
:REPLY-TO :EXPIRATION :MESSAGE-ID :TIMESTAMP :TYPE :USER-ID :APP-ID :CLUSTER-ID :HEADERS

Package

cl-rabbit.

Source

amqp.lisp.

Function: basic-qos (conn channel &key global prefetch-size prefetch-count) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: channel-close (conn channel &key code) ¶

Closes a channel.
Parameters:
CONN - the connection object
CHANNEL - the channel that should be closed
CODE - the reason code, defaults to AMQP_REPLY_SUCCESS

Package

cl-rabbit.

Source

amqp.lisp.

Function: channel-flow (conn channel active) ¶

Enable/disable flow from peer.

This method asks the peer to pause or restart the flow of content data sent by a consumer. This is a simple flow-control mechanism that a peer can use to avoid overflowing its queues or otherwise finding itself receiving more messages than it can process. Note that this method is not intended for window control. It does not affect contents returned by Basic.Get-Ok methods.

Parameters:
CONN - the connection object
CHANNEL - the channel that should be updated
ACTIVE - a boolean indicating if flow should be enabled or disabled

Package

cl-rabbit.

Source

amqp.lisp.

Function: channel-open (conn channel) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: confirm-select (conn channel) ¶

Set CHANNEL to publisher confirm mode. a channel in transaction mode cannot be set to confirm mode. returns t if successful. signals RABBITMQ-SERVER-ERROR if channel is in transaction mode.

Package

cl-rabbit.

Source

amqp.lisp.

Function: consume-message (conn &key timeout) ¶

Wait for and consume a message.
Waits for a basic.deliver method on any channel, upon receipt of basic.deliver it reads that message, and returns. If any other method is received before basic.deliver, this function will raise a RABBITMQ-LIBRARY-ERROR with its error code set
to :AMQP-UNEXPECTED-FRAME. The caller should then call amqp_simple_wait_frame() to read this frame and take appropriate action.

This function should be used after starting a consumer with the BASIC-CONSUME function.

This function returns an instance of ENVELOPE that contains the consumed message.

Parameters:

CONN - the connection object

TIMEOUT - the number of microseconds to wait for a message delivery. Passing in NIL will result in blocking behaviour.

Package

cl-rabbit.

Source

amqp.lisp.

Function: destroy-connection (conn) ¶

Close a connection that was previously created using NEW-CONNECTION.

Package

cl-rabbit.

Source

amqp.lisp.

Function: exchange-bind (conn channel &key destination source routing-key arguments) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: exchange-declare (conn channel exchange type &key passive durable auto-delete internal arguments) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: exchange-delete (conn channel exchange &key if-unused) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: exchange-unbind (conn channel &key destination source routing-key) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: login-sasl-plain (conn vhost user password &key channel-max frame-max heartbeat properties) ¶

Login to the broker using the SASL PLAIN method.

Parameters:

CONN - The connection object

VHOST - the virtual host to connect to on the broker. The default on most brokers is "/"

CHANNEL-MAX - the limit for the number of channels for the connection. 0 means no limit, and is a good default (AMQP_DEFAULT_MAX_CHANNELS) Note that the maximum number of channels the protocol supports is 65535 (2^16, with the 0-channel reserved)

FRAME-MAX - the maximum size of an AMQP frame on the wire to request of the broker for this connection. 4096 is the minimum size, 2^31-1 is the maximum, the default value is 131072 (128 kB).

HEARTBEAT - the number of seconds between heartbeat frame to request of the broker. A value of 0 disables heartbeats.

PROPERTIES - a table of properties to send to the broker

Package

cl-rabbit.

Source

amqp.lisp.

Function: new-connection () ¶

Create a new connection. The returned connection must be released using DESTROY-CONNECTION. As an alternative, WITH-CONNECTION can be used, which ensures that the connection is properly closed.

Package

cl-rabbit.

Source

amqp.lisp.

Function: queue-bind (conn channel &key queue exchange routing-key arguments) ¶

Bind queue to an exchange.

This method binds a queue to an exchange. Until a queue is bound it will not receive any messages. In a classic messaging model, store-and-forward queues are bound to a direct exchange and subscription queues are bound to a topic exchange.

Package

cl-rabbit.

Source

amqp.lisp.

Function: queue-declare (conn channel &key queue passive durable exclusive auto-delete arguments) ¶

Declare queue, create if needed.

This method creates or checks a queue. When creating a new queue the client can specify various properties that control the durability of the queue and its contents, and the level of sharing for the queue.

This function returns three values: The name of the queue, the number of messages waiting on the queue, the number of consumers for this queue.

Package

cl-rabbit.

Source

amqp.lisp.

Function: queue-delete (conn channel queue &key if-unused if-empty) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: queue-purge (conn channel queue) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: queue-unbind (conn channel &key queue exchange routing-key arguments) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: set-init-ssl-library (init) ¶

Sets whether rabbitmq-c initialises the underlying SSL library.

For SSL libraries that require a one-time initialisation across
a whole program (e.g., OpenSSL) this sets whether or not rabbitmq-c will initialise the SSL library when the first call to amqp_open_socket() is made. You should call this function with do_init = 0 if the underlying SSL library is initialised somewhere else the program.

Failing to initialise or double initialisation of the SSL library will result in undefined behaviour

By default rabbitmq-c will initialise the underlying SSL library

NOTE: calling this function after the first socket has been opened with amqp_open_socket() will not have any effect.

INIT - If NIL rabbitmq-c will not initialise the SSL library, otherwise rabbitmq-c will initialise the SSL library

Package

cl-rabbit.

Source

amqp.lisp.

Function: simple-wait-frame (conn) ¶

Returns frame object for supported frames (see notes section), t for confirmation (ok) frames or signals error for unsupported (not implemented frames), this function waits for frame on ANY CHANNEL on CONN.

Arguments:
CONN => Rabbitmq connection.

NOTES:
Currently implemented frames are basic acknowledgment, basic negative acknowledgment, return, deliver and select ok method frames, content header and content body frames.

Package

cl-rabbit.

Source

amqp.lisp.

Function: socket-open (socket host port) ¶

Open a socket connection.
This function opens a socket connection returned from TCP-SOCKET-NEW or SSL-SOCKET-NEW.

Package

cl-rabbit.

Source

amqp.lisp.

Function: ssl-socket-new (conn) ¶

Create a new TLS-encrypted socket.
Call CONNECTION-CLOSE to release socket resources.

Package

cl-rabbit.

Source

amqp.lisp.

Function: ssl-socket-set-cacert (socket cacert) ¶

Set the CA certificate.
SOCKET is a socket object created by SSL-SOCKET-NEW. CACERT is the path to a certificate file in PEM format.

Package

cl-rabbit.

Source

amqp.lisp.

Function: ssl-socket-set-key (socket cert key) ¶

Set the client key from a buffer.

SOCKET - An SSL/TLS socket object.
CERT - Path to the client certificate in PEM format. KEY - Path to the client key in PEM format.

Package

cl-rabbit.

Source

amqp.lisp.

Function: ssl-socket-set-key-buffer (socket cert key) ¶

Set the client key from a buffer.

SOCKET - An SSL/TLS socket object.
CERT - Path to the client certificate in PEM format.
KEY - An array of type (UNSIGNED-BYTE 8) containing client key in PEM format.

Package

cl-rabbit.

Source

amqp.lisp.

Function: ssl-socket-set-verify (socket verify-p) ¶

Enable or disable peer verification.

If peer verification is enabled then the common name in the server certificate must match the server name. Peer verification is enabled by default.

SOCKET - An SSL/TLS socket object.
VERIFY-P - verify Enable or disable peer verification.

Package

cl-rabbit.

Source

amqp.lisp.

Function: tcp-socket-new (conn) ¶

Create a new TCP socket.
Call CONNECTION-CLOSE to release socket resources.

Package

cl-rabbit.

Source

amqp.lisp.

Function: tx-commit (conn channel) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: tx-rollback (conn channel) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: tx-select (conn channel) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: version () ¶

Package

cl-rabbit.

Source

amqp.lisp.

---

6.1.3 Generic functions

Generic Reader: content-body-frame/body (object) ¶

Package

cl-rabbit.

Methods

Reader Method: content-body-frame/body ((content-body-frame content-body-frame)) ¶

Body payload raw content.

Source

amqp.lisp.

Target Slot

body.

Generic Reader: content-body-frame/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: content-body-frame/channel ((content-body-frame content-body-frame)) ¶

Rabbitmq channel.

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: content-header-frame/body-size (object) ¶

Package

cl-rabbit.

Methods

Reader Method: content-header-frame/body-size ((content-header-frame content-header-frame)) ¶

Body payload size in bytes.

Source

amqp.lisp.

Target Slot

body-size.

Generic Reader: content-header-frame/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: content-header-frame/channel ((content-header-frame content-header-frame)) ¶

channel.

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: content-header-frame/class-id (object) ¶

Package

cl-rabbit.

Methods

Reader Method: content-header-frame/class-id ((content-header-frame content-header-frame)) ¶

AMQP class id.

Source

amqp.lisp.

Target Slot

class-id.

Generic Reader: content-header-frame/properties (object) ¶

Package

cl-rabbit.

Methods

Reader Method: content-header-frame/properties ((content-header-frame content-header-frame)) ¶

Payload properties.

Source

amqp.lisp.

Target Slot

properties.

Generic Reader: envelope/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: envelope/channel ((envelope envelope)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: envelope/consumer-tag (object) ¶

Package

cl-rabbit.

Methods

Reader Method: envelope/consumer-tag ((envelope envelope)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

consumer-tag.

Generic Reader: envelope/delivery-tag (object) ¶

Package

cl-rabbit.

Methods

Reader Method: envelope/delivery-tag ((envelope envelope)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

delivery-tag.

Generic Reader: envelope/exchange (object) ¶

Package

cl-rabbit.

Methods

Reader Method: envelope/exchange ((envelope envelope)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

exchange.

Generic Reader: envelope/message (object) ¶

Package

cl-rabbit.

Methods

Reader Method: envelope/message ((envelope envelope)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

message.

Generic Reader: envelope/routing-key (object) ¶

Package

cl-rabbit.

Methods

Reader Method: envelope/routing-key ((envelope envelope)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

routing-key.

Generic Reader: message/body (object) ¶

Package

cl-rabbit.

Methods

Reader Method: message/body ((message message)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

body.

Generic Reader: message/properties (object) ¶

Package

cl-rabbit.

Methods

Reader Method: message/properties ((message message)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

properties.

Generic Reader: method-frame-basic-acknowledgment/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-acknowledgment/channel ((method-frame-basic-acknowledgment method-frame-basic-acknowledgment)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: method-frame-basic-acknowledgment/delivery-tag (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-acknowledgment/delivery-tag ((method-frame-basic-acknowledgment method-frame-basic-acknowledgment)) ¶

Sequence number of the confirmed message.

Source

amqp.lisp.

Target Slot

delivery-tag.

Generic Reader: method-frame-basic-acknowledgment/id (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-acknowledgment/id ((method-frame-basic-acknowledgment method-frame-basic-acknowledgment)) ¶

Basic acknowledgment method ID.

Source

amqp.lisp.

Target Slot

id.

Generic Reader: method-frame-basic-acknowledgment/multiplep (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-acknowledgment/multiplep ((method-frame-basic-acknowledgment method-frame-basic-acknowledgment)) ¶

t when acknowledge messages up to and including the one with the sequence in delivery-tag.

Source

amqp.lisp.

Target Slot

multiplep.

Generic Reader: method-frame-basic-deliver/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/channel ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: method-frame-basic-deliver/consumer-tag (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/consumer-tag ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

Identifier for the consumer, valid within the current channel. The server-assigned and channel-specific delivery tag

Source

amqp.lisp.

Target Slot

consumer-tag.

Generic Reader: method-frame-basic-deliver/delivery-tag (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/delivery-tag ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

Sequence number of confirmed message.

Source

amqp.lisp.

Target Slot

delivery-tag.

Generic Reader: method-frame-basic-deliver/exchange (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/exchange ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

Exchange name.

Source

amqp.lisp.

Target Slot

exchange.

Generic Reader: method-frame-basic-deliver/id (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/id ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

Basic deliver method ID.

Source

amqp.lisp.

Target Slot

id.

Generic Reader: method-frame-basic-deliver/redeliveredp (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/redeliveredp ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

t when message is redelivered, after it was not successfully acknowledged by a consumer.

Source

amqp.lisp.

Target Slot

redeliveredp.

Generic Reader: method-frame-basic-deliver/routing-key (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-deliver/routing-key ((method-frame-basic-deliver method-frame-basic-deliver)) ¶

Message routing key.

Source

amqp.lisp.

Target Slot

routing-key.

Generic Reader: method-frame-basic-negative-acknowledgment/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-negative-acknowledgment/channel ((method-frame-basic-negative-acknowledgment method-frame-basic-negative-acknowledgment)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: method-frame-basic-negative-acknowledgment/id (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-negative-acknowledgment/id ((method-frame-basic-negative-acknowledgment method-frame-basic-negative-acknowledgment)) ¶

Basic negative acknowledgment method ID.

Source

amqp.lisp.

Target Slot

id.

Generic Reader: method-frame-basic-negative-acknowledgment/multiplep (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-negative-acknowledgment/multiplep ((method-frame-basic-negative-acknowledgment method-frame-basic-negative-acknowledgment)) ¶

t when acknowledge messages up to and including the one with the sequence in delivery-tag.

Source

amqp.lisp.

Target Slot

multiplep.

Generic Reader: method-frame-basic-negative-acknowledgment/requeuep (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-negative-acknowledgment/requeuep ((method-frame-basic-negative-acknowledgment method-frame-basic-negative-acknowledgment)) ¶

t when instructing the broker to requeue message. this slot should be ignored when publisher receives negative acknowledgment from broker.

Source

amqp.lisp.

Target Slot

requeuep.

Generic Reader: method-frame-basic-return/channel (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-return/channel ((method-frame-basic-return method-frame-basic-return)) ¶

automatically generated reader method

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: method-frame-basic-return/exchange (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-return/exchange ((method-frame-basic-return method-frame-basic-return)) ¶

Exchange name.

Source

amqp.lisp.

Target Slot

exchange.

Generic Reader: method-frame-basic-return/id (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-return/id ((method-frame-basic-return method-frame-basic-return)) ¶

Basic return method ID.

Source

amqp.lisp.

Target Slot

id.

Generic Reader: method-frame-basic-return/reply-code (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-return/reply-code ((method-frame-basic-return method-frame-basic-return)) ¶

The AMQ reply code.

Source

amqp.lisp.

Target Slot

reply-code.

Generic Reader: method-frame-basic-return/reply-text (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-return/reply-text ((method-frame-basic-return method-frame-basic-return)) ¶

The localized reply text. this text can be logged as an aid to resolving issues.

Source

amqp.lisp.

Target Slot

reply-text.

Generic Reader: method-frame-basic-return/routing-key (object) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-basic-return/routing-key ((method-frame-basic-return method-frame-basic-return)) ¶

Message routing key.

Source

amqp.lisp.

Target Slot

routing-key.

Generic Reader: method-frame-error/channel (condition) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-error/channel ((condition method-frame-error)) ¶

Source

amqp.lisp.

Target Slot

channel.

Generic Reader: method-frame-error/method-id (condition) ¶

Package

cl-rabbit.

Methods

Reader Method: method-frame-error/method-id ((condition method-frame-error)) ¶

Source

amqp.lisp.

Target Slot

method-id.

Generic Reader: rabbitmq-library-error/error-code (condition) ¶

Package

cl-rabbit.

Methods

Reader Method: rabbitmq-library-error/error-code ((condition rabbitmq-library-error)) ¶

Source

amqp.lisp.

Target Slot

error-code.

Generic Reader: rabbitmq-library-error/error-description (condition) ¶

Package

cl-rabbit.

Methods

Reader Method: rabbitmq-library-error/error-description ((condition rabbitmq-library-error)) ¶

Source

amqp.lisp.

Target Slot

error-description.

Generic Reader: rabbitmq-server-error/message (condition) ¶

Package

cl-rabbit.

Methods

Reader Method: rabbitmq-server-error/message ((condition rabbitmq-server-error)) ¶

Source

amqp.lisp.

Target Slot

message.

Generic Reader: rabbitmq-server-error/reply-code (condition) ¶

Package

cl-rabbit.

Methods

Reader Method: rabbitmq-server-error/reply-code ((condition rabbitmq-server-error)) ¶

Source

amqp.lisp.

Target Slot

reply-code.

---

6.1.4 Standalone methods

Method: print-object ((obj message) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj method-frame-basic-deliver) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj content-body-frame) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj method-frame-basic-negative-acknowledgment) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj method-frame-basic-return) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj envelope) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj method-frame-basic-acknowledgment) stream) ¶

Source

amqp.lisp.

Method: print-object ((obj content-header-frame) stream) ¶

Source

amqp.lisp.

---

6.1.5 Conditions

Condition: method-frame-error ¶

Error signaled when an unhandled method type recieved in a method frame.

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

rabbitmq-error.

Direct methods

• method-frame-error/channel.
• method-frame-error/method-id.

Direct slots

Slot: channel ¶

Initargs

:channel

Readers

method-frame-error/channel.

Writers

This slot is read-only.

Slot: method-id ¶

Initargs

:method-id

Readers

method-frame-error/method-id.

Writers

This slot is read-only.

Condition: rabbitmq-error ¶

General superclass for rabbitmq errors

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

error.

Direct subclasses

• method-frame-error.
• rabbitmq-library-error.
• rabbitmq-server-error.

Condition: rabbitmq-library-error ¶

Error that is raised when an AMQP call fails

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

rabbitmq-error.

Direct methods

• rabbitmq-library-error/error-code.
• rabbitmq-library-error/error-description.

Direct slots

Slot: error-code ¶

The response type as returned by the AMQP call

Initargs

:error-code

Readers

rabbitmq-library-error/error-code.

Writers

This slot is read-only.

Slot: error-description ¶

Initargs

:error-description

Readers

rabbitmq-library-error/error-description.

Writers

This slot is read-only.

Condition: rabbitmq-server-error ¶

Error that is raised when the server reports an error condition

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

rabbitmq-error.

Direct methods

• rabbitmq-server-error/message.
• rabbitmq-server-error/method.
• rabbitmq-server-error/reply-code.

Direct slots

Slot: method ¶

Package

common-lisp.

Initargs

:method

Readers

rabbitmq-server-error/method.

Writers

This slot is read-only.

Slot: reply-code ¶

Initform

(quote 0)

Initargs

:reply-code

Readers

rabbitmq-server-error/reply-code.

Writers

This slot is read-only.

Slot: message ¶

Initform

(quote "unknown error")

Initargs

:message

Readers

rabbitmq-server-error/message.

Writers

This slot is read-only.

---

6.1.6 Classes

Class: content-body-frame ¶

Content body frame

Package

cl-rabbit.

Source

amqp.lisp.

Direct methods

• content-body-frame/body.
• content-body-frame/channel.
• print-object.

Direct slots

Slot: channel ¶

Rabbitmq channel.

Type

integer

Initargs

:channel

Readers

content-body-frame/channel.

Writers

This slot is read-only.

Slot: body ¶

Body payload raw content.

Type

(simple-array (unsigned-byte 8) (*))

Initargs

:body

Readers

content-body-frame/body.

Writers

This slot is read-only.

Class: content-header-frame ¶

Content header frame.

Package

cl-rabbit.

Source

amqp.lisp.

Direct methods

• content-header-frame/body-size.
• content-header-frame/channel.
• content-header-frame/class-id.
• content-header-frame/properties.
• print-object.

Direct slots

Slot: channel ¶

channel.

Type

integer

Initargs

:channel

Readers

content-header-frame/channel.

Writers

This slot is read-only.

Slot: class-id ¶

AMQP class id.

Type

integer

Initargs

:class-id

Readers

content-header-frame/class-id.

Writers

This slot is read-only.

Slot: body-size ¶

Body payload size in bytes.

Type

integer

Initargs

:body-size

Readers

content-header-frame/body-size.

Writers

This slot is read-only.

Slot: properties ¶

Payload properties.

Type

list

Initargs

:properties

Readers

content-header-frame/properties.

Writers

This slot is read-only.

Class: envelope ¶

Package

cl-rabbit.

Source

amqp.lisp.

Direct methods

• envelope/channel.
• envelope/consumer-tag.
• envelope/delivery-tag.
• envelope/exchange.
• envelope/message.
• envelope/routing-key.
• print-object.

Direct slots

Slot: channel ¶

Type

integer

Initargs

:channel

Readers

envelope/channel.

Writers

This slot is read-only.

Slot: consumer-tag ¶

Type

string

Initargs

:consumer-tag

Readers

envelope/consumer-tag.

Writers

This slot is read-only.

Slot: delivery-tag ¶

Type

integer

Initargs

:delivery-tag

Readers

envelope/delivery-tag.

Writers

This slot is read-only.

Slot: exchange ¶

Type

string

Initargs

:exchange

Readers

envelope/exchange.

Writers

This slot is read-only.

Slot: routing-key ¶

Type

string

Initargs

:routing-key

Readers

envelope/routing-key.

Writers

This slot is read-only.

Slot: message ¶

Type

cl-rabbit:message

Initargs

:message

Readers

envelope/message.

Writers

This slot is read-only.

Class: message ¶

Package

cl-rabbit.

Source

amqp.lisp.

Direct methods

• message/body.
• message/properties.
• print-object.

Direct slots

Slot: body ¶

Type

(simple-array (unsigned-byte 8) (*))

Initargs

:body

Readers

message/body.

Writers

This slot is read-only.

Slot: properties ¶

Type

list

Initargs

:properties

Readers

message/properties.

Writers

This slot is read-only.

Class: method-frame-basic-acknowledgment ¶

Basic acknowledgment method frame.

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

method-frame.

Direct methods

• method-frame-basic-acknowledgment/channel.
• method-frame-basic-acknowledgment/delivery-tag.
• method-frame-basic-acknowledgment/id.
• method-frame-basic-acknowledgment/multiplep.
• print-object.

Direct slots

Slot: channel ¶

Readers

method-frame-basic-acknowledgment/channel.

Writers

This slot is read-only.

Slot: id ¶

Basic acknowledgment method ID.

Allocation

:class

Initform

3932240

Readers

method-frame-basic-acknowledgment/id.

Writers

This slot is read-only.

Slot: delivery-tag ¶

Sequence number of the confirmed message.

Type

integer

Initargs

:delivery-tag

Readers

method-frame-basic-acknowledgment/delivery-tag.

Writers

This slot is read-only.

Slot: multiplep ¶

t when acknowledge messages up to and including the one with the sequence in delivery-tag.

Initargs

:multiplep

Readers

method-frame-basic-acknowledgment/multiplep.

Writers

This slot is read-only.

Class: method-frame-basic-deliver ¶

Basic deliver method frame.

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

method-frame.

Direct methods

• method-frame-basic-deliver/channel.
• method-frame-basic-deliver/consumer-tag.
• method-frame-basic-deliver/delivery-tag.
• method-frame-basic-deliver/exchange.
• method-frame-basic-deliver/id.
• method-frame-basic-deliver/redeliveredp.
• method-frame-basic-deliver/routing-key.
• print-object.

Direct slots

Slot: channel ¶

Readers

method-frame-basic-deliver/channel.

Writers

This slot is read-only.

Slot: id ¶

Basic deliver method ID.

Allocation

:class

Initform

3932220

Readers

method-frame-basic-deliver/id.

Writers

This slot is read-only.

Slot: consumer-tag ¶

Identifier for the consumer, valid within the current channel. The server-assigned and channel-specific delivery tag

Type

string

Initargs

:consumer-tag

Readers

method-frame-basic-deliver/consumer-tag.

Writers

This slot is read-only.

Slot: delivery-tag ¶

Sequence number of confirmed message.

Type

integer

Initargs

:delivery-tag

Readers

method-frame-basic-deliver/delivery-tag.

Writers

This slot is read-only.

Slot: redeliveredp ¶

t when message is redelivered, after it was not successfully acknowledged by a consumer.

Initargs

:redeliveredp

Readers

method-frame-basic-deliver/redeliveredp.

Writers

This slot is read-only.

Slot: exchange ¶

Exchange name.

Type

string

Initargs

:exchange

Readers

method-frame-basic-deliver/exchange.

Writers

This slot is read-only.

Slot: routing-key ¶

Message routing key.

Type

string

Initargs

:routing-key

Readers

method-frame-basic-deliver/routing-key.

Writers

This slot is read-only.

Class: method-frame-basic-negative-acknowledgment ¶

Basic negative acknowledgment (nack) method frame.

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

method-frame.

Direct methods

• method-frame-basic-negative-acknowledgment/channel.
• method-frame-basic-negative-acknowledgment/delivery-tag.
• method-frame-basic-negative-acknowledgment/id.
• method-frame-basic-negative-acknowledgment/multiplep.
• method-frame-basic-negative-acknowledgment/requeuep.
• print-object.

Direct slots

Slot: channel ¶

Readers

method-frame-basic-negative-acknowledgment/channel.

Writers

This slot is read-only.

Slot: id ¶

Basic negative acknowledgment method ID.

Allocation

:class

Initform

3932280

Readers

method-frame-basic-negative-acknowledgment/id.

Writers

This slot is read-only.

Slot: delivery-tag ¶

Sequence number of the negatively confirmed message.

Type

integer

Initargs

:delivery-tag

Readers

method-frame-basic-negative-acknowledgment/delivery-tag.

Writers

This slot is read-only.

Slot: multiplep ¶

t when acknowledge messages up to and including the one with the sequence in delivery-tag.

Initargs

:multiplep

Readers

method-frame-basic-negative-acknowledgment/multiplep.

Writers

This slot is read-only.

Slot: requeuep ¶

t when instructing the broker to requeue message. this slot should be ignored when publisher receives negative acknowledgment from broker.

Initargs

:requeuep

Readers

method-frame-basic-negative-acknowledgment/requeuep.

Writers

This slot is read-only.

Class: method-frame-basic-return ¶

Basic return method frame.

Package

cl-rabbit.

Source

amqp.lisp.

Direct superclasses

method-frame.

Direct methods

• method-frame-basic-return/channel.
• method-frame-basic-return/exchange.
• method-frame-basic-return/id.
• method-frame-basic-return/reply-code.
• method-frame-basic-return/reply-text.
• method-frame-basic-return/routing-key.
• print-object.

Direct slots

Slot: channel ¶

Readers

method-frame-basic-return/channel.

Writers

This slot is read-only.

Slot: id ¶

Basic return method ID.

Allocation

:class

Initform

3932210

Readers

method-frame-basic-return/id.

Writers

This slot is read-only.

Slot: reply-code ¶

The AMQ reply code.

Type

integer

Initargs

:reply-code

Readers

method-frame-basic-return/reply-code.

Writers

This slot is read-only.

Slot: reply-text ¶

The localized reply text. this text can be logged as an aid to resolving issues.

Type

string

Initargs

:reply-text

Readers

method-frame-basic-return/reply-text.

Writers

This slot is read-only.

Slot: exchange ¶

Exchange name.

Type

string

Initargs

:exchange

Readers

method-frame-basic-return/exchange.

Writers

This slot is read-only.

Slot: routing-key ¶

Message routing key.

Type

string

Initargs

:routing-key

Readers

method-frame-basic-return/routing-key.

Writers

This slot is read-only.

---

6.2.1 Special variables

Special Variable: *field-kind-types* ¶

Package

cl-rabbit.

Source

misc.lisp.

Special Variable: *props-mapping* ¶

Package

cl-rabbit.

Source

amqp.lisp.

---

6.2.2 Macros

Macro: print-unreadable-safely ((&rest slots) object stream &body body) ¶

A version of PRINT-UNREADABLE-OBJECT and WITH-SLOTS that is safe to use with unbound slots

Package

cl-rabbit.

Source

misc.lisp.

Macro: unwind-when-fail (form &body unwind-forms) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-amqp-table ((table values) &body body) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-bytes-string ((symbol string) &body body) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-bytes-strings ((&rest definitions) &body body) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-bytes-struct ((symbol value) &body body) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-foreign-buffer-from-byte-array ((sym buffer) &body body) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-foreign-timeval ((symbol time) &body body) ¶

Package

cl-rabbit.

Source

misc.lisp.

Macro: with-state ((state conn) &body body) ¶

Package

cl-rabbit.

Source

amqp.lisp.

---

6.2.3 Ordinary functions

Function: %check-client-version (name major minor patch) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: allocate-amqp-table (values) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: amqp-basic-ack (state channel delivery-tag multiple) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-cancel (state channel consumer-tag) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-consume (state channel queue consumer-tag no-local no-ack exclusive arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-get (state channel queue no-ack) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-nack (state channel delivery-tag multiple requeue) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-publish (state channel exchange routing-key mandatory immediate properties body) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-qos (state channel prefetch_size prefetch_count global) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-basic-reject (state channel delivery-tag requeue) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-channel-close (state channel code) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-channel-flow (state channel active) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-channel-open (state channel) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-confirm-select (state channel) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-connection-close (state code) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-consume-message (state envelope timeout flags) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-cstring-bytes (cstr) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-data-in-buffer (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-destroy-connection (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-destroy-envelope (envelope) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-error-string2 (err) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-exchange-bind (state channel destination source routing-key arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-exchange-declare-0-5 (state channel exchange type passive durable arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-exchange-declare-0-6 (state channel exchange type passive durable auto-delete internal arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-exchange-delete (state channel exchange if-unused) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-exchange-unbind (state channel destination source routing-key arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-frames-enqueued (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-get-rpc-reply (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-get-sockfd (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-login-sasl-plain (state vhost channel-max frame-max heartbeat sasl-method user password) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-login-sasl-plain-with-properties (state vhost channel-max frame-max heartbeat properties sasl-method user password) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-maybe-release-buffers (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-maybe-release-buffers-on-channel (state channel) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-new-connection () ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-queue-bind (state channel queue exchange routing-key arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-queue-declare (state channel queue passive durable exclusive auto-delete arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-queue-delete (state channel queue if-unused if-empty) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-queue-purge (state channel queue) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-queue-unbind (state channel queue exchange routing-key arguments) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-send-frame (state frame) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-send-method (state channel id decoded) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-set-initialize-ssl-library (init) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-simple-wait-frame (state decoded-frame) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-simple-wait-frame-noblock (state decoded-frame tv) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-socket-get-sockfd (self) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-socket-open (self host port) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-ssl-socket-new (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-ssl-socket-set-cacert (socket cacert) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-ssl-socket-set-key (socket cert key) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-ssl-socket-set-key-buffer (socket cert key) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-ssl-socket-set-verify (socket verify) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-table->lisp (table) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: amqp-tcp-socket-new (state) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-tcp-socket-set-sockfd (self sockfd) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-tx-commit (state channel) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-tx-rollback (state channel) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-tx-select (state channel) ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: amqp-version () ¶

Package

cl-rabbit.

Source

functions.lisp.

Function: array-to-foreign-char-array (array) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: bytes->array (bytes) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: bytes->string (bytes) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: bzero-ptr (ptr size) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: call-with-amqp-table (fn values) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: call-with-timeval (fn time) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: check-client-version (major minor patch) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: confirm-channel-close (state channel) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: connection-close (conn &key code) ¶

Closes the entire connection.
Implicitly closes all channels and informs the broker the connection
is being closed, after receiving acknowldgement from the broker it closes
the socket.

Parameters:
CONN - the connection object
CODE - the reason code for closing the connection. Defaults to AMQP_REPLY_SUCCESS.

Package

cl-rabbit.

Source

amqp.lisp.

Function: convert-to-bytes (array) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: data-in-buffer (conn) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: fail-if-null (ptr) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: fill-in-properties-alist (properties) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: frames-enqueued (conn) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: get-sockfd (conn) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: load-properties-to-alist (props) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-content-body-frame (channel body) ¶

Returns fresh object of CONTENT-BODY-FRAME.

Arguments:

CHANNEL => INTEGER, Rabbitmq channel. BODY => ARRAY of BYTES, contents.

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-content-header-frame (channel class-id body-size properties) ¶

Returns fresh object of CONTENT-HEADER-FRAME

Arguments:

CHANNEL => INTEGER, Rabbitmq channel. CLASS-ID => INTEGER, AMQP class id.
BODY-SIZE => INTEGER, Body payload size in bytes. PROPERTIES => ALIST, Payload properties.

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-envelope-message (value) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-method-frame-basic-acknowledgment (channel delivery-tag multiplep) ¶

Returns fresh object of METHOD-FRAME-BASIC-ACKNOWLEDGMENT.

Arguments:

CHANNEL => INTEGER, Rabbitmq channel.
DELIVERY-TAG => INTEGER, sequence number of confirmed message.
MULTIPLEP => BOOLEAN, t when acknowledge messages up to and including the one with the sequence in delivery-tag.

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-method-frame-basic-deliver (channel consumer-tag delivery-tag redeliveredp exchange routing-key) ¶

Returns fresh object of METHOD-FRAME-BASIC-DELIVER.

Arguments:

CHANNEL => INTEGER, Rabbitmq channel.
CONSUMER-TAG => STRING, identifier for the consumer, valid within the current channel. DELIVERY-TAG => INTEGER, sequence number of confirmed message.
REDELIVEREDP => BOOLEAN, t when message is redelivered after it was not successfully acknowledged by a consumer.
EXCHANGE => STRING, Exchange name.
ROUTING-KEY => STRING, Message routing key.

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-method-frame-basic-negative-acknowledgment (channel delivery-tag multiplep requeuep) ¶

Returns fresh object of METHOD-FRAME-BASIC-NEGATIVE-ACKNOWLEDGMENT

Arguments:

CHANNEL => INTEGER, Rabbitmq channel.
DELIVERY-TAG => INTEGER, sequence number of confirmed message.
MULTIPLEP => BOOLEAN, t when acknowledge messages up to and including the one with the sequence in delivery-tag. REQUEUEP => BOOLEAN, t when instructing the broker to requeue message. this slot should be
ignored when publisher receives negative acknowledgment from broker.

Package

cl-rabbit.

Source

amqp.lisp.

Function: make-method-frame-basic-return (channel reply-code reply-text exchange routing-key) ¶

Returns fresh object of METHOD-FRAME-BASIC-RETURN.

Arguments:

CHANNEL => INTEGER, Rabbitmq channel.
REPLY-CODE => INTEGER, AMQ reply code.
REPLY-TEXT => STRING, localized reply text. this text can be logged as an aid to resolving issues. EXCHANGE => STRING, Rabbitmq exchange name.
ROUTING-KEY => STRING, Message routing key.

Package

cl-rabbit.

Source

amqp.lisp.

Function: maybe-release-buffers (state) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: raise-method-frame-error (channel method-id) ¶

Signals an error of method

Package

cl-rabbit.

Source

amqp.lisp.

Function: raise-rabbitmq-library-error (code) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: raise-rabbitmq-server-error (state channel result) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: typed-value->lisp (value) ¶

Package

cl-rabbit.

Source

misc.lisp.

Function: update-product-name-in-table (table) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: verify-rpc-framing-call (state channel result) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: verify-rpc-reply (state channel result) ¶

Package

cl-rabbit.

Source

amqp.lisp.

Function: verify-status (status) ¶

Package

cl-rabbit.

Source

amqp.lisp.

---