This is the cl-xmpp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:50:53 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-xmppCommon Lisp XMPP client implementation
Erik Enge
MIT
usocket (system).
cxml (system).
ironclad (system).
package.lisp (file).
variable.lisp (file).
utility.lisp (file).
result.lisp (file).
cl-xmpp.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-xmpp/cl-xmpp.asdcl-xmpp/package.lispcl-xmpp/variable.lispcl-xmpp/utility.lispcl-xmpp/result.lispcl-xmpp/cl-xmpp.lispcl-xmpp/variable.lisppackage.lisp (file).
cl-xmpp (system).
*debug-stream* (special variable).
*default-hostname* (special variable).
*errors* (special variable).
*auth-methods* (special variable).
*default-port* (special variable).
cl-xmpp/utility.lispvariable.lisp (file).
cl-xmpp (system).
add-auth-method (function).
default-stanza-callback (function).
digestify-string (function).
ensure-keyword (function).
flatten (function).
fmt (macro).
get-auth-method (function).
list-auth-method-names (function).
make-digest-password (function).
vector-to-array (function).
cl-xmpp/result.lisputility.lisp (file).
cl-xmpp (system).
attributes (reader method).
(setf attributes) (writer method).
body (reader method).
(setf body) (writer method).
data (method).
data (reader method).
(setf data) (writer method).
disco (class).
disco-info (class).
disco-items (class).
elements (reader method).
(setf elements) (writer method).
event (class).
features (reader method).
(setf features) (writer method).
from (reader method).
from (reader method).
(setf from) (writer method).
(setf from) (writer method).
get-attribute (method).
get-element (method).
identities (reader method).
(setf identities) (writer method).
identity- (class).
item (class).
items (reader method).
items (reader method).
(setf items) (writer method).
(setf items) (writer method).
jid (reader method).
jid (reader method).
(setf jid) (writer method).
(setf jid) (writer method).
message (class).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
(setf name) (writer method).
node (reader method).
node (reader method).
node (reader method).
(setf node) (writer method).
(setf node) (writer method).
(setf node) (writer method).
presence (class).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
roster (class).
to (reader method).
to (reader method).
(setf to) (writer method).
(setf to) (writer method).
value (method).
value (reader method).
(setf value) (writer method).
xml-attribute (class).
xml-element (reader method).
(setf xml-element) (writer method).
xml-element (class).
xmpp-protocol-error (class).
xmpp-protocol-error-auth (class).
xmpp-protocol-error-cancel (class).
xmpp-protocol-error-modify (class).
xmpp-protocol-error-wait (class).
category (reader method).
(setf category) (writer method).
code (reader method).
(setf code) (writer method).
contact (class).
feature (class).
get-error-data-code (function).
get-error-data-name (function).
id (reader method).
(setf id) (writer method).
make-disco-info (method).
make-disco-items (method).
make-error (method).
make-feature (method).
make-identity (method).
make-item (method).
make-roster (method).
map-error-type-to-class (function).
show (reader method).
(setf show) (writer method).
subscription (reader method).
(setf subscription) (writer method).
type- (reader method).
type- (reader method).
type- (reader method).
(setf type-) (writer method).
(setf type-) (writer method).
(setf type-) (writer method).
var (reader method).
(setf var) (writer method).
cl-xmpp/cl-xmpp.lispresult.lisp (file).
cl-xmpp (system).
approve-subscription (method).
auth (method).
auth-requirements (method).
begin-xml-stream (method).
bind (method).
connect (function).
connectedp (method).
connection (class).
deny/cancel-subscription (method).
disconnect (method).
discover (method).
end-xml-stream (method).
feature-p (method).
feature-required-p (method).
features (reader method).
(setf features) (writer method).
get-privacy-list (method).
get-privacy-lists (method).
get-roster (method).
handle (method).
handle (method).
hostname (reader method).
(setf hostname) (writer method).
mechanism-p (method).
mechanisms (reader method).
(setf mechanisms) (writer method).
message (method).
port (reader method).
(setf port) (writer method).
presence (method).
print-object (method).
receive-stanza (method).
receive-stanza-loop (method).
register (method).
registration-requirements (method).
request-subscription (method).
roster-add (method).
roster-remove (method).
server-stream (reader method).
(setf server-stream) (writer method).
session (method).
unsubscribe (method).
username (reader method).
(setf username) (writer method).
with-iq (macro).
with-iq-query (macro).
%digest-md5-auth% (method).
%plain-auth% (method).
cancel-registration (method).
change-password (method).
dom-to-event (method).
dom-to-event (method).
jid-domain-part (reader method).
(setf jid-domain-part) (writer method).
parse-result (method).
parse-result (method).
parse-result (method).
parse-result (method).
parse-result (method).
parse-result (method).
read-stanza (function).
server-source (reader method).
(setf server-source) (writer method).
stream-id (reader method).
(setf stream-id) (writer method).
with-xml-output (macro).
with-xml-stream (macro).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-element-to-event (method).
xml-output (function).
Packages are listed by definition order.
cl-xmppxmpp
common-lisp.
*debug-stream* (special variable).
*default-hostname* (special variable).
*errors* (special variable).
approve-subscription (generic function).
attributes (generic reader).
(setf attributes) (generic writer).
auth (generic function).
auth-requirements (generic function).
begin-xml-stream (generic function).
bind (generic function).
body (generic reader).
(setf body) (generic writer).
connect (function).
connectedp (generic function).
connection (class).
data (generic function).
(setf data) (generic writer).
deny/cancel-subscription (generic function).
disco (class).
disco-info (class).
disco-items (class).
disconnect (generic function).
discover (generic function).
elements (generic reader).
(setf elements) (generic writer).
end-xml-stream (generic function).
event (class).
feature-p (generic function).
feature-required-p (generic function).
features (generic reader).
(setf features) (generic writer).
from (generic reader).
(setf from) (generic writer).
get-attribute (generic function).
get-element (generic function).
get-privacy-list (generic function).
get-privacy-lists (generic function).
get-roster (generic function).
handle (generic function).
hostname (generic reader).
(setf hostname) (generic writer).
identities (generic reader).
(setf identities) (generic writer).
identity- (class).
item (class).
items (generic reader).
(setf items) (generic writer).
jid (generic reader).
(setf jid) (generic writer).
mechanism-p (generic function).
mechanisms (generic reader).
(setf mechanisms) (generic writer).
message (generic function).
message (class).
name (generic reader).
(setf name) (generic writer).
node (generic reader).
(setf node) (generic writer).
port (generic reader).
(setf port) (generic writer).
presence (generic function).
presence (class).
receive-stanza (generic function).
receive-stanza-loop (generic function).
register (generic function).
registration-requirements (generic function).
request-subscription (generic function).
roster (class).
roster-add (generic function).
roster-remove (generic function).
server-stream (generic reader).
(setf server-stream) (generic writer).
session (generic function).
to (generic reader).
(setf to) (generic writer).
unsubscribe (generic function).
username (generic reader).
(setf username) (generic writer).
value (generic function).
(setf value) (generic writer).
with-iq (macro).
with-iq-query (macro).
xml-attribute (class).
xml-element (generic reader).
(setf xml-element) (generic writer).
xml-element (class).
xmpp-protocol-error (class).
xmpp-protocol-error-auth (class).
xmpp-protocol-error-cancel (class).
xmpp-protocol-error-modify (class).
xmpp-protocol-error-wait (class).
%digest-md5-auth% (generic function).
%plain-auth% (generic function).
*auth-methods* (special variable).
*default-port* (special variable).
add-auth-method (function).
cancel-registration (generic function).
category (generic reader).
(setf category) (generic writer).
change-password (generic function).
code (generic reader).
(setf code) (generic writer).
contact (class).
default-stanza-callback (function).
digestify-string (function).
dom-to-event (generic function).
ensure-keyword (function).
feature (class).
flatten (function).
fmt (macro).
get-auth-method (function).
get-error-data-code (function).
get-error-data-name (function).
id (generic reader).
(setf id) (generic writer).
jid-domain-part (generic reader).
(setf jid-domain-part) (generic writer).
list-auth-method-names (function).
make-digest-password (function).
make-disco-info (generic function).
make-disco-items (generic function).
make-error (generic function).
make-feature (generic function).
make-identity (generic function).
make-item (generic function).
make-roster (generic function).
map-error-type-to-class (function).
parse-result (generic function).
read-stanza (function).
server-source (generic reader).
(setf server-source) (generic writer).
show (generic reader).
(setf show) (generic writer).
stream-id (generic reader).
(setf stream-id) (generic writer).
subscription (generic reader).
(setf subscription) (generic writer).
type- (generic reader).
(setf type-) (generic writer).
var (generic reader).
(setf var) (generic writer).
vector-to-array (function).
with-xml-output (macro).
with-xml-stream (macro).
xml-element-to-event (generic function).
xml-output (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A character stream, or nil
Macro to make it easier to write IQ stanzas.
Macro to make it easier to write QUERYs.
Open TCP connection to hostname.
By default this will set up the complete XML stream and receive the initial
two stanzas (which would typically be stream:stream and stream:features)
to make sure the connection object is fully loaded with the features,
mechanisms and stream-id. If this is causing a problem for you just
specify :receive-stanzas nil.
Using the same idea, you can disable the calling to begin-xml-stream.
Some XMPP server’s addresses are not the same as the domain part of
the JID (eg. talk.google.com vs gmail.com) so we provide the option of
passing that in here. Could perhaps be taken care of by the library
but I’m trying not to optimize too early plus if you are going to
do in-band registration (JEP0077) then you don’t have a JID until
after you’ve connected.
connection) to) ¶xml-element)) ¶automatically generated reader method
xml-element)) ¶automatically generated writer method
connection) username password resource &key mechanism bind-et-al send-presence) ¶If bind-et-al is T this operator will bind, create a session and call presence on your behalf if the authentication was successful.
connection) username) ¶connection) &key xml-identifier) ¶Begin XML stream. This should be the first thing to happen on a newly connected connection.
connection) resource) ¶connection)) ¶Returns t if ‘connection’ is connected to a server and is ready for input.
xml-element)) ¶automatically generated reader method
data.
xml-element)) ¶automatically generated writer method
data.
connection) to) ¶connection)) ¶Disconnect TCP connection.
connection) &key type to node) ¶xml-element)) ¶automatically generated reader method
xml-element)) ¶automatically generated writer method
connection)) ¶Closes the XML stream. At this point you’d have to call BEGIN-XML-STREAM if you wished to communicate with the server again.
connection) feature-name) ¶See if connection has a specific feature.
Eg. (has-feature *my-connection* :starttls)
Returns the xml-element representing the feature if it is present, nil otherwise.
connection) feature-name) ¶Checks if feature is required. Three possible outcomes
t - feature is supported and required
nil - feature is support but not required
:not-supported - feature is not supported
connection)) ¶List of xml-element objects representing
the various features the host at the other end of the connection
supports.
disco-info)) ¶automatically generated reader method
connection)) ¶List of xml-element objects representing
the various features the host at the other end of the connection
supports.
disco-info)) ¶automatically generated writer method
xml-element) name &key test) ¶xml-element) name &key test) ¶connection) name) ¶connection)) ¶connection)) ¶connection) object) ¶connection) (list list)) ¶connection)) ¶automatically generated reader method
connection)) ¶automatically generated writer method
disco-items)) ¶automatically generated reader method
disco-items)) ¶automatically generated writer method
connection) mechanism-name) ¶connection)) ¶connection)) ¶List of xml-element objects representing
the various mechainsms the host at the other end of the connection
will accept.
connection) to body &key id type) ¶xmpp-protocol-error)) ¶automatically generated reader method
name.
identity-)) ¶automatically generated reader method
name.
contact)) ¶automatically generated reader method
name.
xml-attribute)) ¶automatically generated reader method
name.
xml-element)) ¶automatically generated reader method
name.
xmpp-protocol-error)) ¶automatically generated writer method
name.
item)) ¶automatically generated writer method
name.
identity-)) ¶automatically generated writer method
name.
contact)) ¶automatically generated writer method
name.
xml-attribute)) ¶automatically generated writer method
name.
xml-element)) ¶automatically generated writer method
name.
xml-attribute)) ¶automatically generated reader method
node.
xml-element)) ¶Attaching CXML DOM node here but please
do not rely on it beyond introspection. If you find yourself
in need of getting data from it stick it somewhere in the
cl-xmpp-created data and access it that way instead.
node.
item)) ¶automatically generated writer method
node.
xml-attribute)) ¶automatically generated writer method
node.
xml-element)) ¶Attaching CXML DOM node here but please
do not rely on it beyond introspection. If you find yourself
in need of getting data from it stick it somewhere in the
cl-xmpp-created data and access it that way instead.
node.
connection)) ¶automatically generated reader method
port.
connection)) ¶automatically generated writer method
port.
connection) &key type to status show priority) ¶connection) &key stanza-callback dom-repr) ¶Returns one stanza. Hangs until one is received.
connection) &key stanza-callback dom-repr) ¶Reads from connection’s stream and parses the XML received on-the-go. As soon as it has a complete element it calls the stanza-callback (which by default eventually dispatches to HANDLE).
connection) username password name email) ¶connection)) ¶connection) to) ¶connection) jid name group) ¶connection) jid) ¶connection)) ¶automatically generated reader method
connection)) ¶automatically generated writer method
connection)) ¶connection) to) ¶connection)) ¶automatically generated reader method
connection)) ¶automatically generated writer method
xml-attribute)) ¶automatically generated reader method
xml-attribute)) ¶automatically generated writer method
connection) stream) ¶Print the object for the Lisp reader.
xmpp-protocol-error) stream) ¶Print the object for the Lisp reader.
xml-element) stream) ¶Print the object for the Lisp reader.
xml-attribute) stream) ¶Print the object for the Lisp reader.
A TCP connection between this XMPP client and
an, assumed, XMPP compliant server. The connection does not
know whether or not the XML stream has been initiated nor whether
there may be any reply waiting to be read from the stream. These
details are left to the programmer.
%digest-md5-auth%.
%plain-auth%.
approve-subscription.
auth.
auth-requirements.
begin-xml-stream.
bind.
cancel-registration.
change-password.
connectedp.
deny/cancel-subscription.
disconnect.
discover.
dom-to-event.
dom-to-event.
end-xml-stream.
feature-p.
feature-required-p.
(setf features).
features.
get-privacy-list.
get-privacy-lists.
get-roster.
handle.
handle.
(setf hostname).
hostname.
(setf jid-domain-part).
jid-domain-part.
mechanism-p.
(setf mechanisms).
mechanisms.
message.
parse-result.
parse-result.
parse-result.
parse-result.
parse-result.
parse-result.
(setf port).
port.
presence.
print-object.
receive-stanza.
receive-stanza-loop.
register.
registration-requirements.
request-subscription.
roster-add.
roster-remove.
(setf server-source).
server-source.
(setf server-stream).
server-stream.
session.
(setf stream-id).
stream-id.
unsubscribe.
(setf username).
username.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
:server-stream
Stream ID attribute of the <stream>
element as gotten when we call BEGIN-XML-STREAM.
:stream-id
List of xml-element objects representing
the various features the host at the other end of the connection
supports.
:features
List of xml-element objects representing
the various mechainsms the host at the other end of the connection
will accept.
:mechanisms
:jid-domain-part
:username
cl-xmpp:*default-hostname*
:hostname
:identities
:features
:items
:xml-element
(setf jid).
jid.
(setf name).
name.
(setf node).
node.
(setf body).
body.
(setf from).
from.
(setf id).
id.
print-object.
(setf to).
to.
(setf type-).
type-.
common-lisp.
:type
:items
(setf attributes).
attributes.
(setf data).
data.
dom-to-event.
(setf elements).
elements.
get-attribute.
get-element.
make-disco-info.
make-disco-items.
make-error.
make-feature.
make-identity.
make-item.
make-roster.
(setf name).
name.
(setf node).
node.
print-object.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
xml-element-to-event.
Attaching CXML DOM node here but please
do not rely on it beyond introspection. If you find yourself
in need of getting data from it stick it somewhere in the
cl-xmpp-created data and access it that way instead.
:node
node.
:attributes
:elements
Alist of method name to operator.
Operators must accept the following operands:
connection username password resource
Helper macro to make it easy to control outputting XML to the debug stream. It’s not strictly /with/ xml-stream so it should probably be renamed.
Makes a keyword except when it gets nil it just returns nil.
Write string to stream as a sequence of bytes and not characters.
connection) username password resource) ¶connection) username password resource) ¶connection)) ¶connection) new-password) ¶xmpp-protocol-error)) ¶automatically generated reader method
code.
xmpp-protocol-error)) ¶automatically generated writer method
code.
connection) (object xml-element)) ¶connection) (objects list)) ¶connection)) ¶automatically generated reader method
connection)) ¶automatically generated writer method
xml-element)) ¶xml-element)) ¶xml-element)) ¶xml-element)) ¶xml-element)) ¶xml-element)) ¶xml-element)) ¶connection) (node element)) ¶connection) (node node)) ¶connection) (node character-data)) ¶connection) (attribute attribute)) ¶connection) (document document)) ¶connection) (objects list)) ¶connection)) ¶automatically generated reader method
connection)) ¶automatically generated writer method
connection)) ¶connection)) ¶Stream ID attribute of the <stream>
element as gotten when we call BEGIN-XML-STREAM.
identity-)) ¶automatically generated reader method
presence)) ¶automatically generated reader method
identity-)) ¶automatically generated writer method
presence)) ¶automatically generated writer method
connection) (object xml-element) (name (eql :message))) ¶connection) (object xml-element) (name (eql :presence))) ¶connection) (object xml-element) name) ¶connection) (object xml-element) (name (eql :success))) ¶connection) (object xml-element) (name (eql :|stream:features|))) ¶connection) (object xml-element) (name (eql :|stream:stream|))) ¶connection) (object xml-element) (name (eql :|stream:error|))) ¶connection) (object xml-element) (name (eql :error))) ¶connection) (object xml-element) (name (eql :iq))) ¶| Jump to: | %
(
A B C D E F G H I J L M N P R S T U V W X |
|---|
| Jump to: | %
(
A B C D E F G H I J L M N P R S T U V W X |
|---|
| Jump to: | *
A B C D E F H I J M N P S T U V X |
|---|
| Jump to: | *
A B C D E F H I J M N P S T U V X |
|---|
| Jump to: | C D E F I M P R S U V X |
|---|
| Jump to: | C D E F I M P R S U V X |
|---|