The cl-stomp Reference Manual

Table of Contents

The cl-stomp Reference Manual

This is the cl-stomp Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:36:45 2020 GMT+0.

1 Introduction

cl-stomp: Common-Lisp interface to ActiveMQ using the STOMP protocol

This code is available under an MIT-style license. See COPYING.
It was written by Matt J. Reklaitis at ITA Software, based on code
originally published by Keith Irwin in 2007 at http://cl-stomp.googlecode.com

2 Systems

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

2.1 cl-stomp

Author

Keith Irwin, Matt Reklaitis

License

MIT-style License

Description

Implements the STOMP protocol for connecting to a message broker.

Dependencies

• usocket
• babel

Source

cl-stomp.asd (file)

Component

cl-stomp.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-stomp.asd

Location

cl-stomp.asd

Systems

cl-stomp (system)

3.1.2 cl-stomp/cl-stomp.lisp

Parent

cl-stomp (system)

Location

cl-stomp.lisp

Packages

cl-stomp

Exported Definitions

• ack (generic function)
• ack (method)
• amq-key-mapping-strategy (class)
• begin (generic function)
• begin (method)
• commit (generic function)
• commit (method)
• frame (class)
• frame-body (method)
• (setf frame-body) (method)
• frame-headers (method)
• (setf frame-headers) (method)
• frame-name (method)
• (setf frame-name) (method)
• get-destination (generic function)
• get-destination (method)
• get-header (generic function)
• get-header (method)
• make-connection (function)
• pass-through-key-mapping-strategy (class)
• post (generic function)
• post (method)
• register (generic function)
• register (method)
• register-error (generic function)
• register-error (method)
• rollback (generic function)
• rollback (method)
• set-destination (generic function)
• set-destination (method)
• set-header (generic function)
• set-header (method)
• start (generic function)
• start (method)
• stop (generic function)
• stop (method)
• subscribe (generic function)
• subscribe (method)
• unregister-id (generic function)
• unregister-id (method)
• unsubscribe (generic function)
• unsubscribe (method)
• unsubscribe-id (generic function)
• unsubscribe-id (method)

Internal Definitions

• *replacement-pairs* (special variable)
• apply-callbacks (method)
• connect (method)
• connection (class)
• demangle-key (generic function)
• demangle-key (method)
• demangle-key (method)
• 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)
• mangle-key (method)
• mangle-key (method)
• 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)

4 Packages

Packages are listed by definition order.

4.1 cl-stomp

Source

cl-stomp.lisp (file)

Nickname

stomp

Use List

• common-lisp-user
• common-lisp

Exported Definitions

• ack (generic function)
• ack (method)
• amq-key-mapping-strategy (class)
• begin (generic function)
• begin (method)
• commit (generic function)
• commit (method)
• frame (class)
• frame-body (generic function)
• frame-body (method)
• (setf frame-body) (method)
• (setf frame-body) (generic function)
• frame-headers (generic function)
• frame-headers (method)
• (setf frame-headers) (method)
• (setf frame-headers) (generic function)
• frame-name (generic function)
• frame-name (method)
• (setf frame-name) (method)
• (setf frame-name) (generic function)
• get-destination (generic function)
• get-destination (method)
• get-header (generic function)
• get-header (method)
• make-connection (function)
• pass-through-key-mapping-strategy (class)
• post (generic function)
• post (method)
• register (generic function)
• register (method)
• register-error (generic function)
• register-error (method)
• rollback (generic function)
• rollback (method)
• set-destination (generic function)
• set-destination (method)
• set-header (generic function)
• set-header (method)
• start (generic function)
• start (method)
• stop (generic function)
• stop (method)
• subscribe (generic function)
• subscribe (method)
• unregister-id (generic function)
• unregister-id (method)
• unsubscribe (generic function)
• unsubscribe (method)
• unsubscribe-id (generic function)
• unsubscribe-id (method)

Internal Definitions

• *replacement-pairs* (special variable)
• apply-callbacks (generic function)
• apply-callbacks (method)
• connect (generic function)
• connect (method)
• connection (class)
• demangle-key (generic function)
• demangle-key (method)
• demangle-key (method)
• destination= (function)
• disconnect (generic function)
• disconnect (method)
• error-frame-p (generic function)
• error-frame-p (method)
• get-subscription (generic function)
• get-subscription (method)
• header= (function)
• log-debug (function)
• make-frame-from-string (function)
• mangle-key (generic function)
• mangle-key (method)
• mangle-key (method)
• process-receive-buffer (generic function)
• process-receive-buffer (method)
• receive (generic function)
• receive (method)
• registration (class)
• render-frame (generic function)
• render-frame (method)
• send (generic function)
• send (method)
• send (method)
• sending-frame (macro)
• set-client-ack (generic function)
• set-client-ack (method)
• set-id (generic function)
• set-id (method)
• set-selector (generic function)
• set-selector (method)
• string-left-strip (function)
• string-replace (function)
• string-split (function)
• string-strip (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: make-connection HOST PORT &key KEY-MAPPING-STRATEGY

Package

cl-stomp

Source

cl-stomp.lisp (file)

5.1.2 Generic functions

Generic Function: ack CONNECTION FRAME &optional TRANSACTION

Send the client an ACK for frame.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: ack (CONN connection) (FOR-FRAME frame) &optional TRANSACTION

Send the client ack for FRAME and optional TRANSACTION

Generic Function: begin CONNECTION TRANSACTION

Start a transaction with the given name.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: begin (CONN connection) (TRANSACTION string)

Begin a transaction with name TRANSACTION

Generic Function: commit CONNECTION TRANSACTION

Commit a transaction with the given name.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: commit (CONN connection) (TRANSACTION string)

Commit a transaction with name TRANSACTION

Generic Function: frame-body OBJECT

Generic Function: (setf frame-body) NEW-VALUE OBJECT

Package

cl-stomp

Methods

Method: frame-body (FRAME frame)

automatically generated reader method

Source

cl-stomp.lisp (file)

Method: (setf frame-body) NEW-VALUE (FRAME frame)

automatically generated writer method

Source

cl-stomp.lisp (file)

Generic Function: frame-headers OBJECT

Generic Function: (setf frame-headers) NEW-VALUE OBJECT

Package

cl-stomp

Methods

Method: frame-headers (FRAME frame)

automatically generated reader method

Source

cl-stomp.lisp (file)

Method: (setf frame-headers) NEW-VALUE (FRAME frame)

automatically generated writer method

Source

cl-stomp.lisp (file)

Generic Function: frame-name OBJECT

Generic Function: (setf frame-name) NEW-VALUE OBJECT

Package

cl-stomp

Methods

Method: frame-name (FRAME frame)

automatically generated reader method

Source

cl-stomp.lisp (file)

Method: (setf frame-name) NEW-VALUE (FRAME frame)

automatically generated writer method

Source

cl-stomp.lisp (file)

Generic Function: get-destination FRAME

Return the destination header for FRAME.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: get-destination (FRAME frame)

Return the destination header for FRAME.

Generic Function: get-header FRAME KEY

Return the value of the header named KEY, or NIL if it doesn’t exist.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: get-header (FRAME frame) (KEY string)

Return the value of the header named KEY, or NIL if it doesn’t exist.

Generic Function: post CONNECTION MESSAGE DESTINATION &optional HEADERS

Post a message to a destination.
HEADERS is an alist of header name and value pairs.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: post (CONN connection) (MESSAGE string) (DESTINATION string) &optional HEADERS

Generic Function: register CONNECTION CALLBACK DESTINATION &key SELECTOR ID CLIENT-ACK?

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.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: register (CONN 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.

Generic Function: register-error CONNECTION CALLBACK

Register a listener for STOMP error frames.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: register-error (CONN connection) CALLBACK

Register an error callback for STOMP error frames.

Generic Function: rollback CONNECTION TRANSACTION

Abort a transaction with the given name.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: rollback (CONN connection) (TRANSACTION string)

Abort a transaction with name TRANSACTION.

Generic Function: set-destination FRAME DESTINATION

Set the destination header for FRAME.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: set-destination (FRAME frame) (DESTINATION string)

Set the destination header for FRAME.

Generic Function: set-header FRAME KEY VALUE

Add a header named KEY to FRAME with VALUE.
If the header already exists, VALUE replaces the existing value.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: set-header (FRAME frame) (KEY string) VALUE

Add a header named KEY to FRAME with VALUE, which can be of any type. If the header already exists, VALUE replaces the existing value.

Generic Function: start CONNECTION &key USERNAME PASSCODE

Start listening for messages from STOMP.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: start (CONN connection) &key USERNAME PASSCODE

Connects to the message broker, sends subscriptions for any existing registrations, and enters a receive loop.

Generic Function: stop CONNECTION

Stop the connection with STOMP.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: stop (CONN connection)

Gracefully terminates the current receive loop and closes the connection to the message broker.

Generic Function: subscribe CONNECTION DESTINATION &key SELECTOR ID CLIENT-ACK?

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.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: subscribe (CONN connection) (DESTINATION string) &key SELECTOR ID CLIENT-ACK?

Generic Function: unregister-id CONNECTION ID

Unregister a callback by id.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: unregister-id (CONN connection) ID

Generic Function: unsubscribe CONNECTION DESTINATION

Unsubscribe from a topic or queue by name.
Unsubscribing does not unregister any callbacks.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: unsubscribe (CONN connection) (DESTINATION string)

Generic Function: unsubscribe-id CONNECTION ID

Unsubscribe from a topic or queue by id.
Unsubscribing does not unregister any callbacks.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: unsubscribe-id (CONN connection) (ID string)

5.1.3 Classes

Class: amq-key-mapping-strategy ()

Package

cl-stomp

Source

cl-stomp.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• demangle-key (method)
• mangle-key (method)

Class: frame ()

Package

cl-stomp

Source

cl-stomp.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• ack (method)
• apply-callbacks (method)
• send (method)
• error-frame-p (method)
• set-client-ack (method)
• set-id (method)
• set-selector (method)
• get-subscription (method)
• set-destination (method)
• get-destination (method)
• set-header (method)
• get-header (method)
• render-frame (method)
• print-object (method)
• frame-body (method)
• frame-body (method)
• frame-headers (method)
• frame-headers (method)
• frame-name (method)
• frame-name (method)

Direct slots

Slot: name

Type

string

Initargs

:name

Initform

"message"

Readers

frame-name (generic function)

Writers

(setf frame-name) (generic function)

Slot: headers

Type

list

Initargs

:headers

Readers

frame-headers (generic function)

Writers

(setf frame-headers) (generic function)

Slot: body

Type

string

Initargs

:body

Initform

""

Readers

frame-body (generic function)

Writers

(setf frame-body) (generic function)

Class: pass-through-key-mapping-strategy ()

Package

cl-stomp

Source

cl-stomp.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• demangle-key (method)
• mangle-key (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *replacement-pairs*

Package

cl-stomp

Source

cl-stomp.lisp (file)

5.2.2 Macros

Macro: sending-frame (CONNECTION VFRAME NAME &rest HEADERS) &body BODY

Package

cl-stomp

Source

cl-stomp.lisp (file)

5.2.3 Functions

Function: destination= ACTUAL REGISTERED

Returns T if the REGISTERED destination matches the ACTUAL destination.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: header= HEADER1 HEADER2

Case insensitive comparison function for headers.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: log-debug FMT &rest ARGS

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: make-frame-from-string STRING CONNECTION

Construct a frame by parsing STRING according to the STOMP protocol.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: string-left-strip STRING

Remove spaces, tabs and line enders from the beginning of a string.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: string-replace SEARCH REPLACE STRING

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: string-split STRING DELIM

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.

Package

cl-stomp

Source

cl-stomp.lisp (file)

Function: string-strip STRING

Remove spaces, tabs and line enders from both ends of a string.

Package

cl-stomp

Source

cl-stomp.lisp (file)

5.2.4 Generic functions

Generic Function: apply-callbacks CONN FRAME

Package

cl-stomp

Methods

Method: apply-callbacks (CONN connection) (FRAME frame)

Send FRAME to any matching registered callbacks.

Source

cl-stomp.lisp (file)

Generic Function: connect CONN &optional USERNAME PASSCODE

Package

cl-stomp

Methods

Method: connect (CONN connection) &optional USERNAME PASSCODE

Source

cl-stomp.lisp (file)

Generic Function: demangle-key STRATEGY KEY

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: demangle-key (STRATEGY amq-key-mapping-strategy) KEY

Method: demangle-key (STRATEGY pass-through-key-mapping-strategy) KEY

Generic Function: disconnect CONN

Package

cl-stomp

Methods

Method: disconnect (CONN connection)

Source

cl-stomp.lisp (file)

Generic Function: error-frame-p FRAME

Package

cl-stomp

Methods

Method: error-frame-p (FRAME frame)

Source

cl-stomp.lisp (file)

Generic Function: get-subscription FRAME

Package

cl-stomp

Methods

Method: get-subscription (FRAME frame)

Get the subscription header for FRAME, if one exists.

Source

cl-stomp.lisp (file)

Generic Function: mangle-key STRATEGY KEY

Package

cl-stomp

Source

cl-stomp.lisp (file)

Methods

Method: mangle-key (STRATEGY amq-key-mapping-strategy) KEY

Method: mangle-key (STRATEGY pass-through-key-mapping-strategy) KEY

Generic Function: process-receive-buffer CONN BUFFER

Package

cl-stomp

Methods

Method: process-receive-buffer (CONN connection) BUFFER

Try to extract and process frame(s) from buffer. Returns unprocessed buffer.

Source

cl-stomp.lisp (file)

Generic Function: receive CONN

Package

cl-stomp

Methods

Method: receive (CONN 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.

Source

cl-stomp.lisp (file)

Generic Function: render-frame FRAME CONNECTION

Package

cl-stomp

Methods

Method: render-frame (FRAME frame) CONNECTION

Source

cl-stomp.lisp (file)

Generic Function: send CONN FRAME

Package

cl-stomp

Methods

Method: send (CONN connection) (STRING string)

Source

cl-stomp.lisp (file)

Method: send (CONN connection) (FRAME frame)

Source

cl-stomp.lisp (file)

Generic Function: set-client-ack FRAME

Package

cl-stomp

Methods

Method: set-client-ack (FRAME frame)

Specify a ’client’ ack header for FRAME.

Source

cl-stomp.lisp (file)

Generic Function: set-id FRAME ID

Package

cl-stomp

Methods

Method: set-id (FRAME frame) (ID string)

Specify an ’id’ header for FRAME.

Source

cl-stomp.lisp (file)

Generic Function: set-selector FRAME SELECTOR

Package

cl-stomp

Methods

Method: set-selector (FRAME frame) (SELECTOR string)

Specify a ’selector’ header for FRAME.

Source

cl-stomp.lisp (file)

5.2.5 Classes

Class: connection ()

Package

cl-stomp

Source

cl-stomp.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• rollback (method)
• commit (method)
• begin (method)
• ack (method)
• post (method)
• unsubscribe-id (method)
• unsubscribe (method)
• subscribe (method)
• register-error (method)
• unregister-id (method)
• register (method)
• apply-callbacks (method)
• process-receive-buffer (method)
• receive (method)
• send (method)
• send (method)
• disconnect (method)
• connect (method)
• stop (method)
• start (method)

Direct slots

Slot: host

Type

string

Initargs

:host

Initform

"localhost"

Slot: port

Type

integer

Initargs

:port

Initform

61613

Slot: stream

Initargs

:stream

Slot: encoding

Initform

:utf-8

Slot: registrations

Type

list

Initargs

:registrations

Slot: key-mapping-strategy

Initargs

:key-mapping-strategy

Initform

(make-instance (quote cl-stomp:pass-through-key-mapping-strategy))

Slot: error-callback

Type

(or null function)

Slot: terminate

Class: registration ()

Package

cl-stomp

Source

cl-stomp.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: callback

Type

(or null function)

Initargs

:callback

Slot: destination

Type

string

Initargs

:destination

Slot: selector

Type

(or null string)

Initargs

:selector

Slot: id

Type

(or null string)

Initargs

:id

Slot: client-ack?

Initargs

:client-ack?

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types