This is the cl-rabbit Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:18:50 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-rabbit
Simple RabbitMQ interface for Common Lisp using CFFI
Elias Martenson <lokedhs@gmail.com>
MIT
cffi
(system).
cffi-libffi
(system).
alexandria
(system).
babel
(system).
cl-ppcre
(system).
src
(module).
Modules are listed depth-first from the system components tree.
cl-rabbit/src
cl-rabbit
(system).
package.lisp
(file).
grovel.lisp
(file).
functions.lisp
(file).
misc.lisp
(file).
amqp.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-rabbit/cl-rabbit.asd
cl-rabbit/src/package.lisp
cl-rabbit/src/grovel.lisp
cl-rabbit/src/functions.lisp
cl-rabbit/src/misc.lisp
cl-rabbit/src/amqp.lisp
cl-rabbit/src/grovel.lisp
package.lisp
(file).
src
(module).
cl-rabbit/src/functions.lisp
grovel.lisp
(file).
src
(module).
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).
cl-rabbit/src/misc.lisp
functions.lisp
(file).
src
(module).
*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).
cl-rabbit/src/amqp.lisp
misc.lisp
(file).
src
(module).
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).
%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).
Packages are listed by definition order.
cl-rabbit
CFFI-based interface to RabbitMQ
common-lisp
.
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
(generic reader).
content-body-frame/channel
(generic reader).
content-header-frame
(class).
content-header-frame/body-size
(generic reader).
content-header-frame/channel
(generic reader).
content-header-frame/class-id
(generic reader).
content-header-frame/properties
(generic reader).
destroy-connection
(function).
envelope
(class).
envelope/channel
(generic reader).
envelope/consumer-tag
(generic reader).
envelope/delivery-tag
(generic reader).
envelope/exchange
(generic reader).
envelope/message
(generic reader).
envelope/routing-key
(generic reader).
exchange-bind
(function).
exchange-declare
(function).
exchange-delete
(function).
exchange-unbind
(function).
login-sasl-plain
(function).
message
(class).
message/body
(generic reader).
message/properties
(generic reader).
method-frame-basic-acknowledgment
(class).
method-frame-basic-acknowledgment/channel
(generic reader).
method-frame-basic-acknowledgment/delivery-tag
(generic reader).
method-frame-basic-acknowledgment/id
(generic reader).
method-frame-basic-acknowledgment/multiplep
(generic reader).
method-frame-basic-deliver
(class).
method-frame-basic-deliver/channel
(generic reader).
method-frame-basic-deliver/consumer-tag
(generic reader).
method-frame-basic-deliver/delivery-tag
(generic reader).
method-frame-basic-deliver/exchange
(generic reader).
method-frame-basic-deliver/id
(generic reader).
method-frame-basic-deliver/redeliveredp
(generic reader).
method-frame-basic-deliver/routing-key
(generic reader).
method-frame-basic-negative-acknowledgment
(class).
method-frame-basic-negative-acknowledgment/channel
(generic reader).
method-frame-basic-negative-acknowledgment/id
(generic reader).
method-frame-basic-negative-acknowledgment/multiplep
(generic reader).
method-frame-basic-negative-acknowledgment/requeuep
(generic reader).
method-frame-basic-return
(class).
method-frame-basic-return/channel
(generic reader).
method-frame-basic-return/exchange
(generic reader).
method-frame-basic-return/id
(generic reader).
method-frame-basic-return/reply-code
(generic reader).
method-frame-basic-return/reply-text
(generic reader).
method-frame-basic-return/routing-key
(generic reader).
method-frame-error
(condition).
method-frame-error/channel
(generic reader).
method-frame-error/method-id
(generic reader).
new-connection
(function).
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
(generic reader).
rabbitmq-library-error/error-description
(generic reader).
rabbitmq-server-error
(condition).
rabbitmq-server-error/message
(generic reader).
rabbitmq-server-error/reply-code
(generic reader).
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).
%check-client-version
(function).
*field-kind-types*
(special variable).
*props-mapping*
(special variable).
allocate-amqp-table
(function).
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-table->lisp
(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).
array-to-foreign-char-array
(function).
bytes->array
(function).
bytes->string
(function).
bzero-ptr
(function).
call-with-amqp-table
(function).
call-with-timeval
(function).
check-client-version
(function).
confirm-channel-close
(function).
connection
(class).
connection-close
(function).
connection/closed-p
(generic reader).
(setf connection/closed-p)
(generic writer).
connection/native-connection
(generic reader).
convert-to-bytes
(function).
data-in-buffer
(function).
fail-if-null
(function).
fill-in-properties-alist
(function).
foreign-method->class
(generic function).
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
(generic reader).
method-frame/channel
(generic reader).
method-frame/id
(generic reader).
print-unreadable-safely
(macro).
rabbitmq-server-error/method
(generic reader).
raise-method-frame-error
(function).
raise-rabbitmq-library-error
(function).
raise-rabbitmq-server-error
(function).
typed-value->lisp
(function).
unwind-when-fail
(macro).
update-product-name-in-table
(function).
verify-rpc-framing-call
(function).
verify-rpc-reply
(function).
verify-status
(function).
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).
with-state
(macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Opens CHANNEL, evaluates BODY and ensures you don’t leave without closing the channel
Creates a connection using NEW-CONNECTION and evaluates BODY with the connection bound to CONN.
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
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
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
Closes a channel.
Parameters:
CONN - the connection object
CHANNEL - the channel that should be closed
CODE - the reason code, defaults to AMQP_REPLY_SUCCESS
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
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.
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.
Close a connection that was previously created using NEW-CONNECTION.
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
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.
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.
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.
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
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.
Open a socket connection.
This function opens a socket connection returned from TCP-SOCKET-NEW
or SSL-SOCKET-NEW.
Create a new TLS-encrypted socket.
Call CONNECTION-CLOSE to release socket resources.
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.
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.
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.
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.
Create a new TCP socket.
Call CONNECTION-CLOSE to release socket resources.
content-body-frame
)) ¶Body payload raw content.
content-body-frame
)) ¶Rabbitmq channel.
content-header-frame
)) ¶Body payload size in bytes.
content-header-frame
)) ¶channel.
content-header-frame
)) ¶AMQP class id.
content-header-frame
)) ¶Payload properties.
method-frame-basic-acknowledgment
)) ¶automatically generated reader method
method-frame-basic-acknowledgment
)) ¶Sequence number of the confirmed message.
method-frame-basic-acknowledgment
)) ¶Basic acknowledgment method ID.
method-frame-basic-acknowledgment
)) ¶t when acknowledge messages up to and including the one with the sequence in delivery-tag.
method-frame-basic-deliver
)) ¶automatically generated reader method
method-frame-basic-deliver
)) ¶Identifier for the consumer, valid within the current channel. The server-assigned and channel-specific delivery tag
method-frame-basic-deliver
)) ¶Sequence number of confirmed message.
method-frame-basic-deliver
)) ¶Exchange name.
method-frame-basic-deliver
)) ¶Basic deliver method ID.
method-frame-basic-deliver
)) ¶t when message is redelivered, after it was not successfully acknowledged by a consumer.
method-frame-basic-deliver
)) ¶Message routing key.
method-frame-basic-negative-acknowledgment
)) ¶automatically generated reader method
method-frame-basic-negative-acknowledgment
)) ¶Basic negative acknowledgment method ID.
method-frame-basic-negative-acknowledgment
)) ¶t when acknowledge messages up to and including the one with the sequence in delivery-tag.
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.
method-frame-basic-return
)) ¶automatically generated reader method
method-frame-basic-return
)) ¶Exchange name.
method-frame-basic-return
)) ¶Basic return method ID.
method-frame-basic-return
)) ¶The AMQ reply code.
method-frame-basic-return
)) ¶The localized reply text. this text can be logged as an aid to resolving issues.
method-frame-basic-return
)) ¶Message routing key.
method-frame-error
)) ¶method-frame-error
)) ¶rabbitmq-library-error
)) ¶rabbitmq-library-error
)) ¶rabbitmq-server-error
)) ¶rabbitmq-server-error
)) ¶content-header-frame
) stream) ¶method-frame-basic-negative-acknowledgment
) stream) ¶method-frame-basic-return
) stream) ¶method-frame-basic-acknowledgment
) stream) ¶method-frame-basic-deliver
) stream) ¶content-body-frame
) stream) ¶Error signaled when an unhandled method type recieved in a method frame.
General superclass for rabbitmq errors
error
.
Error that is raised when an AMQP call fails
Error that is raised when the server reports an error condition
common-lisp
.
:method
This slot is read-only.
(quote 0)
:reply-code
This slot is read-only.
(quote "unknown error")
:message
This slot is read-only.
Content body frame
Content header frame.
channel.
integer
:channel
This slot is read-only.
AMQP class id.
integer
:class-id
This slot is read-only.
Body payload size in bytes.
integer
:body-size
This slot is read-only.
Payload properties.
list
:properties
This slot is read-only.
integer
:channel
This slot is read-only.
string
:consumer-tag
This slot is read-only.
integer
:delivery-tag
This slot is read-only.
string
:exchange
This slot is read-only.
string
:routing-key
This slot is read-only.
cl-rabbit:message
:message
This slot is read-only.
Basic acknowledgment method frame.
This slot is read-only.
Basic acknowledgment method ID.
:class
3932240
This slot is read-only.
Sequence number of the confirmed message.
integer
:delivery-tag
This slot is read-only.
t when acknowledge messages up to and including the one with the sequence in delivery-tag.
:multiplep
This slot is read-only.
Basic deliver method frame.
This slot is read-only.
Basic deliver method ID.
:class
3932220
This slot is read-only.
Identifier for the consumer, valid within the current channel. The server-assigned and channel-specific delivery tag
string
:consumer-tag
This slot is read-only.
Sequence number of confirmed message.
integer
:delivery-tag
This slot is read-only.
t when message is redelivered, after it was not successfully acknowledged by a consumer.
:redeliveredp
This slot is read-only.
Exchange name.
string
:exchange
This slot is read-only.
Message routing key.
string
:routing-key
This slot is read-only.
Basic negative acknowledgment (nack) method frame.
This slot is read-only.
Basic negative acknowledgment method ID.
:class
3932280
This slot is read-only.
Sequence number of the negatively confirmed message.
integer
:delivery-tag
This slot is read-only.
t when acknowledge messages up to and including the one with the sequence in delivery-tag.
:multiplep
This slot is read-only.
t when instructing the broker to requeue message. this slot should be ignored when publisher receives negative acknowledgment from broker.
:requeuep
This slot is read-only.
Basic return method frame.
This slot is read-only.
Basic return method ID.
:class
3932210
This slot is read-only.
The AMQ reply code.
integer
:reply-code
This slot is read-only.
The localized reply text. this text can be logged as an aid to resolving issues.
string
:reply-text
This slot is read-only.
Exchange name.
string
:exchange
This slot is read-only.
Message routing key.
string
:routing-key
This slot is read-only.
A version of PRINT-UNREADABLE-OBJECT and WITH-SLOTS that is safe to use with unbound slots
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.
Returns fresh object of CONTENT-BODY-FRAME.
Arguments:
CHANNEL => INTEGER, Rabbitmq channel. BODY => ARRAY of BYTES, contents.
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.
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.
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.
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.
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.
Signals an error of method
connection
)) ¶automatically generated reader method
connection
)) ¶automatically generated writer method
connection
)) ¶automatically generated reader method
Returns t when METHOD-ID equals CONFIRM-SELECT-OK-METHOD otherwise signals and error.
Arguments:
METHOD-ID => INTEGER, AMQP basic return method id.
METHOD-STRUCT => CFFI FOREIGN POINTER, decoded method frame.
CHANNEL => INTEGER, Rabbitmq channel.
(eql 3932220)
) method-struct channel) ¶Returns fresh object of METHOD-FRAME-BASIC-DELIVER filled with data from foreign METHOD-STRUCT.
Arguments:
METHOD-ID => CONSTANT, AMQP basic deliver method id.
METHOD-STRUCT => CFFI FOREIGN POINTER, decoded basic deliver method frame.
CHANNEL => INTEGER, Rabbitmq channel.
(eql 3932210)
) method-struct channel) ¶Returns fresh object of METHOD-FRAME-BASIC-RETURN filled with data from foreign METHOD-STRUCT.
Arguments:
METHOD-ID => CONSTANT, AMQP basic return method id.
METHOD-STRUCT => CFFI FOREIGN POINTER, decoded basic return method frame.
CHANNEL => INTEGER, Rabbitmq channel.
(eql 3932280)
) method-struct channel) ¶Returns fresh object of METHOD-FRAME-BASIC-NEGATIVE-ACKNOWLEDGMENT filled with data from foreign METHOD-STRUCT.
Arguments:
METHOD-ID => CONSTANT, AMQP basic acknowledgment method id.
METHOD-STRUCT => CFFI FOREIGN POINTER, decoded negative basic acknowledgment method frame.
CHANNEL => INTEGER, Rabbitmq channel.
(eql 3932240)
) method-struct channel) ¶Returns fresh object of METHOD-FRAME-BASIC-ACKNOWLEDGMENT filled with data from foreign METHOD-STRUCT.
Arguments:
METHOD-ID => CONSTANT, AMQP basic acknowledgment method id.
METHOD-STRUCT => CFFI FOREIGN POINTER, decoded basic acknowledgment method frame.
CHANNEL => INTEGER, Rabbitmq channel.
method-frame-basic-negative-acknowledgment
)) ¶Sequence number of the negatively confirmed message.
method-frame
)) ¶Frame channel.
method-frame
)) ¶Method id.
rabbitmq-server-error
)) ¶Class representing a connection to a RabbitMQ server.
Parent class for all method frames.
Jump to: | %
(
A B C D E F G L M N P Q R S T U V W |
---|
Jump to: | %
(
A B C D E F G L M N P Q R S T U V W |
---|
Jump to: | *
B C D E I M P R S |
---|
Jump to: | *
B C D E I M P R S |
---|
Jump to: | A C E F G M P R S |
---|
Jump to: | A C E F G M P R S |
---|