This is the cl-stomp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:41:33 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-stompImplements the STOMP protocol for connecting to a message broker.
Keith Irwin, Matt Reklaitis
MIT-style License
usocket (system).
babel (system).
bordeaux-threads (system).
cl-stomp.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-stomp/cl-stomp.lispcl-stomp (system).
ack (generic function).
amq-key-mapping-strategy (class).
begin (generic function).
commit (generic function).
frame (class).
frame-body (reader method).
(setf frame-body) (writer method).
frame-headers (reader method).
(setf frame-headers) (writer method).
frame-name (reader method).
(setf frame-name) (writer method).
get-destination (generic function).
get-header (generic function).
make-connection (function).
pass-through-key-mapping-strategy (class).
post (generic function).
print-object (method).
register (generic function).
register-error (generic function).
rollback (generic function).
set-destination (generic function).
set-header (generic function).
start (generic function).
stop (generic function).
subscribe (generic function).
unregister-id (generic function).
unsubscribe (generic function).
unsubscribe-id (generic function).
*replacement-pairs* (special variable).
apply-callbacks (method).
connect (method).
connection (class).
demangle-key (generic function).
destination= (function).
disconnect (method).
error-frame-p (method).
get-subscription (method).
header= (function).
log-debug (function).
make-frame-from-string (function).
mangle-key (generic function).
process-receive-buffer (method).
receive (method).
registration (class).
render-frame (method).
send (method).
send (method).
sending-frame (macro).
set-client-ack (method).
set-id (method).
set-selector (method).
string-left-strip (function).
string-replace (function).
string-split (function).
string-strip (function).
Packages are listed by definition order.
cl-stompstomp
common-lisp.
common-lisp-user.
ack (generic function).
amq-key-mapping-strategy (class).
begin (generic function).
commit (generic function).
frame (class).
frame-body (generic reader).
(setf frame-body) (generic writer).
frame-headers (generic reader).
(setf frame-headers) (generic writer).
frame-name (generic reader).
(setf frame-name) (generic writer).
get-destination (generic function).
get-header (generic function).
make-connection (function).
pass-through-key-mapping-strategy (class).
post (generic function).
register (generic function).
register-error (generic function).
rollback (generic function).
set-destination (generic function).
set-header (generic function).
start (generic function).
stop (generic function).
subscribe (generic function).
unregister-id (generic function).
unsubscribe (generic function).
unsubscribe-id (generic function).
*replacement-pairs* (special variable).
apply-callbacks (generic function).
connect (generic function).
connection (class).
demangle-key (generic function).
destination= (function).
disconnect (generic function).
error-frame-p (generic function).
get-subscription (generic function).
header= (function).
log-debug (function).
make-frame-from-string (function).
mangle-key (generic function).
process-receive-buffer (generic function).
receive (generic function).
registration (class).
render-frame (generic function).
send (generic function).
sending-frame (macro).
set-client-ack (generic function).
set-id (generic function).
set-selector (generic function).
string-left-strip (function).
string-replace (function).
string-split (function).
string-strip (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Send the client an ACK for frame.
connection) (for-frame frame) &optional transaction) ¶Send the client ack for FRAME and optional TRANSACTION
Start a transaction with the given name.
connection) (transaction string)) ¶Begin a transaction with name TRANSACTION
Commit a transaction with the given name.
connection) (transaction string)) ¶Commit a transaction with name TRANSACTION
Return the destination header for FRAME.
Return the value of the header named KEY, or NIL if it doesn’t exist.
Post a message to a destination.
HEADERS is an alist of header name and value pairs.
connection) (message string) (destination string) &optional headers) ¶Register a listener for messages to a destination.
CALLBACK should be a function which accepts a frame argument.
SELECTOR can be used to provide an SQL 92 selector for filtering
messages. An ID may be given for later use with UNREGISTER-ID
to support overlapping subscriptions using selectors with the
same destination. If CLIENT-ACK? is T, the client is responsible
for sending ACK.
connection) callback (destination string) &key selector id client-ack?) ¶Register a callback for a destination. A subscription to the destination using the optional client-ack? is issued for all callbacks as part of connecting to the MQ server.
Register a listener for STOMP error frames.
connection) callback) ¶Register an error callback for STOMP error frames.
Abort a transaction with the given name.
connection) (transaction string)) ¶Abort a transaction with name TRANSACTION.
Set the destination header for FRAME.
Add a header named KEY to FRAME with VALUE.
If the header already exists, VALUE replaces the existing value.
Start listening for messages from STOMP.
connection) &key username passcode) ¶Connects to the message broker, sends subscriptions for any existing registrations, and enters a receive loop.
Stop the connection with STOMP.
connection)) ¶Gracefully terminates the current receive loop and closes the connection to the message broker.
Subscribe to a topic or queue.
SELECTOR can be used to provide an SQL 92 selector for filtering
messages. An ID may be given for later use with UNSUBSCRIBE-ID
to support overlapping subscriptions using selectors with the
same destination.
connection) (destination string) &key selector id client-ack?) ¶Unregister a callback by id.
connection) id) ¶Unsubscribe from a topic or queue by name.
Unsubscribing does not unregister any callbacks.
connection) (destination string)) ¶Unsubscribe from a topic or queue by id.
Unsubscribing does not unregister any callbacks.
connection) (id string)) ¶Returns T if the REGISTERED destination matches the ACTUAL destination.
Case insensitive comparison function for headers.
Construct a frame by parsing STRING according to the STOMP protocol.
Remove spaces, tabs and line enders from the beginning of a string.
Splits STRING at the first occurrence of DELIM and returns the substrings before and after it. If DELIM is not found in STRING, returns STRING and NIL.
Remove spaces, tabs and line enders from both ends of a string.
connection) (frame frame)) ¶Send FRAME to any matching registered callbacks.
connection) &optional username passcode) ¶amq-key-mapping-strategy) key) ¶pass-through-key-mapping-strategy) key) ¶connection)) ¶amq-key-mapping-strategy) key) ¶pass-through-key-mapping-strategy) key) ¶connection) buffer) ¶Try to extract and process frame(s) from buffer. Returns unprocessed buffer.
connection)) ¶Called whenever there’s activity on the connection stream.
Reads from the stream and returns the received buffer as a list of bytes,
or NIL if the connection has been closed by the broker.
connection) (string string)) ¶connection) (frame frame)) ¶string
"localhost"
:host
integer
61613
:port
common-lisp.
:stream
(bordeaux-threads:make-lock)
:utf-8
list
:registrations
(make-instance (quote cl-stomp:pass-through-key-mapping-strategy))
:key-mapping-strategy
(or null function)
| Jump to: | (
A B C D E F G H L M P R S U |
|---|
| Jump to: | (
A B C D E F G H L M P R S U |
|---|
| Jump to: | *
B C D E H I K N P R S T |
|---|
| Jump to: | *
B C D E H I K N P R S T |
|---|
| Jump to: | A C F P R S |
|---|
| Jump to: | A C F P R S |
|---|