The cl-xmpp Reference Manual

This is the cl-xmpp Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:38:07 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-xmpp

Common Lisp XMPP client implementation

Author

Erik Enge

License

MIT

Dependencies
  • usocket (system).
  • cxml (system).
  • ironclad (system).
Source

cl-xmpp.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-xmpp/cl-xmpp.asd

Source

cl-xmpp.asd.

Parent Component

cl-xmpp (system).

ASDF Systems

cl-xmpp.

Packages

cl-xmpp-system.


3.1.2 cl-xmpp/package.lisp

Source

cl-xmpp.asd.

Parent Component

cl-xmpp (system).

Packages

cl-xmpp.


3.1.3 cl-xmpp/variable.lisp

Dependency

package.lisp (file).

Source

cl-xmpp.asd.

Parent Component

cl-xmpp (system).

Public Interface
Internals

3.1.4 cl-xmpp/utility.lisp

Dependency

variable.lisp (file).

Source

cl-xmpp.asd.

Parent Component

cl-xmpp (system).

Internals

3.1.5 cl-xmpp/result.lisp

Dependency

utility.lisp (file).

Source

cl-xmpp.asd.

Parent Component

cl-xmpp (system).

Public Interface
Internals

3.1.6 cl-xmpp/cl-xmpp.lisp

Dependency

result.lisp (file).

Source

cl-xmpp.asd.

Parent Component

cl-xmpp (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-xmpp-system

Source

cl-xmpp.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 cl-xmpp

Source

package.lisp.

Nickname

xmpp

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *debug-stream*

A character stream, or nil

Package

cl-xmpp.

Source

variable.lisp.

Special Variable: *default-hostname*
Package

cl-xmpp.

Source

variable.lisp.

Special Variable: *errors*
Package

cl-xmpp.

Source

variable.lisp.


5.1.2 Macros

Macro: with-iq ((connection &key id to type) &body body)

Macro to make it easier to write IQ stanzas.

Package

cl-xmpp.

Source

cl-xmpp.lisp.

Macro: with-iq-query ((connection &key xmlns id to node type) &body body)

Macro to make it easier to write QUERYs.

Package

cl-xmpp.

Source

cl-xmpp.lisp.


5.1.3 Ordinary functions

Function: connect (&key hostname port receive-stanzas begin-xml-stream jid-domain-part class)

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.

Package

cl-xmpp.

Source

cl-xmpp.lisp.


5.1.4 Generic functions

Generic Function: approve-subscription (connection to)
Package

cl-xmpp.

Methods
Method: approve-subscription ((connection connection) to)
Source

cl-xmpp.lisp.

Generic Reader: attributes (object)
Package

cl-xmpp.

Methods
Reader Method: attributes ((xml-element xml-element))

automatically generated reader method

Source

result.lisp.

Target Slot

attributes.

Generic Writer: (setf attributes) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf attributes) ((xml-element xml-element))

automatically generated writer method

Source

result.lisp.

Target Slot

attributes.

Generic Function: auth (connection username password resource &key mechanism bind-et-al send-presence)
Package

cl-xmpp.

Methods
Method: auth ((connection 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.

Source

cl-xmpp.lisp.

Generic Function: auth-requirements (connection username)
Package

cl-xmpp.

Methods
Method: auth-requirements ((connection connection) username)
Source

cl-xmpp.lisp.

Generic Function: begin-xml-stream (connection &key xml-identifier)
Package

cl-xmpp.

Methods
Method: begin-xml-stream ((connection connection) &key xml-identifier)

Begin XML stream. This should be the first thing to happen on a newly connected connection.

Source

cl-xmpp.lisp.

Generic Function: bind (connection resource)
Package

cl-xmpp.

Methods
Method: bind ((connection connection) resource)
Source

cl-xmpp.lisp.

Generic Reader: body (object)
Package

cl-xmpp.

Methods
Reader Method: body ((message message))

automatically generated reader method

Source

result.lisp.

Target Slot

body.

Generic Writer: (setf body) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf body) ((message message))

automatically generated writer method

Source

result.lisp.

Target Slot

body.

Generic Function: connectedp (connection)
Package

cl-xmpp.

Methods
Method: connectedp ((connection connection))

Returns t if ‘connection’ is connected to a server and is ready for input.

Source

cl-xmpp.lisp.

Generic Function: data (object)
Package

cl-xmpp.

Methods
Method: data (object)
Source

result.lisp.

Reader Method: data ((xml-element xml-element))

automatically generated reader method

Source

result.lisp.

Target Slot

data.

Generic Writer: (setf data) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf data) ((xml-element xml-element))

automatically generated writer method

Source

result.lisp.

Target Slot

data.

Generic Function: deny/cancel-subscription (connection to)
Package

cl-xmpp.

Methods
Method: deny/cancel-subscription ((connection connection) to)
Source

cl-xmpp.lisp.

Generic Function: disconnect (connection)
Package

cl-xmpp.

Methods
Method: disconnect ((connection connection))

Disconnect TCP connection.

Source

cl-xmpp.lisp.

Generic Function: discover (connection &key type to node)
Package

cl-xmpp.

Methods
Method: discover ((connection connection) &key type to node)
Source

cl-xmpp.lisp.

Generic Reader: elements (object)
Package

cl-xmpp.

Methods
Reader Method: elements ((xml-element xml-element))

automatically generated reader method

Source

result.lisp.

Target Slot

elements.

Generic Writer: (setf elements) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf elements) ((xml-element xml-element))

automatically generated writer method

Source

result.lisp.

Target Slot

elements.

Generic Function: end-xml-stream (connection)
Package

cl-xmpp.

Methods
Method: end-xml-stream ((connection 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.

Source

cl-xmpp.lisp.

Generic Function: feature-p (connection feature-name)
Package

cl-xmpp.

Methods
Method: feature-p ((connection 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.

Source

cl-xmpp.lisp.

Generic Function: feature-required-p (connection feature-name)
Package

cl-xmpp.

Methods
Method: feature-required-p ((connection 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

Source

cl-xmpp.lisp.

Generic Reader: features (object)
Package

cl-xmpp.

Methods
Reader Method: features ((connection connection))

List of xml-element objects representing
the various features the host at the other end of the connection supports.

Source

cl-xmpp.lisp.

Target Slot

features.

Reader Method: features ((disco-info disco-info))

automatically generated reader method

Source

result.lisp.

Target Slot

features.

Generic Writer: (setf features) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf features) ((connection connection))

List of xml-element objects representing
the various features the host at the other end of the connection supports.

Source

cl-xmpp.lisp.

Target Slot

features.

Writer Method: (setf features) ((disco-info disco-info))

automatically generated writer method

Source

result.lisp.

Target Slot

features.

Generic Reader: from (object)
Package

cl-xmpp.

Methods
Reader Method: from ((presence presence))

automatically generated reader method

Source

result.lisp.

Target Slot

from.

Reader Method: from ((message message))

automatically generated reader method

Source

result.lisp.

Target Slot

from.

Generic Writer: (setf from) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf from) ((presence presence))

automatically generated writer method

Source

result.lisp.

Target Slot

from.

Writer Method: (setf from) ((message message))

automatically generated writer method

Source

result.lisp.

Target Slot

from.

Generic Function: get-attribute (element name &key test)
Package

cl-xmpp.

Methods
Method: get-attribute ((element xml-element) name &key test)
Source

result.lisp.

Generic Function: get-element (element name &key test)
Package

cl-xmpp.

Methods
Method: get-element ((element xml-element) name &key test)
Source

result.lisp.

Generic Function: get-privacy-list (connection name)
Package

cl-xmpp.

Methods
Method: get-privacy-list ((connection connection) name)
Source

cl-xmpp.lisp.

Generic Function: get-privacy-lists (connection)
Package

cl-xmpp.

Methods
Method: get-privacy-lists ((connection connection))
Source

cl-xmpp.lisp.

Generic Function: get-roster (connection)
Package

cl-xmpp.

Methods
Method: get-roster ((connection connection))
Source

cl-xmpp.lisp.

Generic Function: handle (connection list)
Package

cl-xmpp.

Methods
Method: handle ((connection connection) object)
Source

cl-xmpp.lisp.

Method: handle ((connection connection) (list list))
Source

cl-xmpp.lisp.

Generic Reader: hostname (object)
Package

cl-xmpp.

Methods
Reader Method: hostname ((connection connection))

automatically generated reader method

Source

cl-xmpp.lisp.

Target Slot

hostname.

Generic Writer: (setf hostname) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf hostname) ((connection connection))

automatically generated writer method

Source

cl-xmpp.lisp.

Target Slot

hostname.

Generic Reader: identities (object)
Package

cl-xmpp.

Methods
Reader Method: identities ((disco disco))

automatically generated reader method

Source

result.lisp.

Target Slot

identities.

Generic Writer: (setf identities) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf identities) ((disco disco))

automatically generated writer method

Source

result.lisp.

Target Slot

identities.

Generic Reader: items (object)
Package

cl-xmpp.

Methods
Reader Method: items ((disco-items disco-items))

automatically generated reader method

Source

result.lisp.

Target Slot

items.

Reader Method: items ((roster roster))

automatically generated reader method

Source

result.lisp.

Target Slot

items.

Generic Writer: (setf items) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf items) ((disco-items disco-items))

automatically generated writer method

Source

result.lisp.

Target Slot

items.

Writer Method: (setf items) ((roster roster))

automatically generated writer method

Source

result.lisp.

Target Slot

items.

Generic Reader: jid (object)
Package

cl-xmpp.

Methods
Reader Method: jid ((item item))

automatically generated reader method

Source

result.lisp.

Target Slot

jid.

Reader Method: jid ((contact contact))

automatically generated reader method

Source

result.lisp.

Target Slot

jid.

Generic Writer: (setf jid) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf jid) ((item item))

automatically generated writer method

Source

result.lisp.

Target Slot

jid.

Writer Method: (setf jid) ((contact contact))

automatically generated writer method

Source

result.lisp.

Target Slot

jid.

Generic Function: mechanism-p (connection mechanism-name)
Package

cl-xmpp.

Methods
Method: mechanism-p ((connection connection) mechanism-name)
Source

cl-xmpp.lisp.

Generic Reader: mechanisms (object)
Generic Writer: (setf mechanisms) (object)
Package

cl-xmpp.

Methods
Reader Method: mechanisms ((connection connection))
Writer Method: (setf mechanisms) ((connection connection))

List of xml-element objects representing
the various mechainsms the host at the other end of the connection will accept.

Source

cl-xmpp.lisp.

Target Slot

mechanisms.

Generic Function: message (connection to body &key id type)
Package

cl-xmpp.

Methods
Method: message ((connection connection) to body &key id type)
Source

cl-xmpp.lisp.

Generic Reader: name (object)
Package

cl-xmpp.

Methods
Reader Method: name ((xmpp-protocol-error xmpp-protocol-error))

automatically generated reader method

Source

result.lisp.

Target Slot

name.

Reader Method: name ((item item))

automatically generated reader method

Source

result.lisp.

Target Slot

name.

Reader Method: name ((identity- identity-))

automatically generated reader method

Source

result.lisp.

Target Slot

name.

Reader Method: name ((contact contact))

automatically generated reader method

Source

result.lisp.

Target Slot

name.

Reader Method: name ((xml-attribute xml-attribute))

automatically generated reader method

Source

result.lisp.

Target Slot

name.

Reader Method: name ((xml-element xml-element))

automatically generated reader method

Source

result.lisp.

Target Slot

name.

Generic Writer: (setf name) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf name) ((xmpp-protocol-error xmpp-protocol-error))

automatically generated writer method

Source

result.lisp.

Target Slot

name.

Writer Method: (setf name) ((item item))

automatically generated writer method

Source

result.lisp.

Target Slot

name.

Writer Method: (setf name) ((identity- identity-))

automatically generated writer method

Source

result.lisp.

Target Slot

name.

Writer Method: (setf name) ((contact contact))

automatically generated writer method

Source

result.lisp.

Target Slot

name.

Writer Method: (setf name) ((xml-attribute xml-attribute))

automatically generated writer method

Source

result.lisp.

Target Slot

name.

Writer Method: (setf name) ((xml-element xml-element))

automatically generated writer method

Source

result.lisp.

Target Slot

name.

Generic Reader: node (object)
Package

cl-xmpp.

Methods
Reader Method: node ((item item))

automatically generated reader method

Source

result.lisp.

Target Slot

node.

Reader Method: node ((xml-attribute xml-attribute))

automatically generated reader method

Source

result.lisp.

Target Slot

node.

Reader Method: node ((xml-element 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.

Source

result.lisp.

Target Slot

node.

Generic Writer: (setf node) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf node) ((item item))

automatically generated writer method

Source

result.lisp.

Target Slot

node.

Writer Method: (setf node) ((xml-attribute xml-attribute))

automatically generated writer method

Source

result.lisp.

Target Slot

node.

Writer Method: (setf node) ((xml-element 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.

Source

result.lisp.

Target Slot

node.

Generic Reader: port (object)
Package

cl-xmpp.

Methods
Reader Method: port ((connection connection))

automatically generated reader method

Source

cl-xmpp.lisp.

Target Slot

port.

Generic Writer: (setf port) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf port) ((connection connection))

automatically generated writer method

Source

cl-xmpp.lisp.

Target Slot

port.

Generic Function: presence (connection &key type to status show priority)
Package

cl-xmpp.

Methods
Method: presence ((connection connection) &key type to status show priority)
Source

cl-xmpp.lisp.

Generic Function: receive-stanza (connection &key stanza-callback dom-repr)
Package

cl-xmpp.

Methods
Method: receive-stanza ((connection connection) &key stanza-callback dom-repr)

Returns one stanza. Hangs until one is received.

Source

cl-xmpp.lisp.

Generic Function: receive-stanza-loop (connection &key stanza-callback dom-repr)
Package

cl-xmpp.

Methods
Method: receive-stanza-loop ((connection 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).

Source

cl-xmpp.lisp.

Generic Function: register (connection username password name email)
Package

cl-xmpp.

Methods
Method: register ((connection connection) username password name email)
Source

cl-xmpp.lisp.

Generic Function: registration-requirements (connection)
Package

cl-xmpp.

Methods
Method: registration-requirements ((connection connection))
Source

cl-xmpp.lisp.

Generic Function: request-subscription (connection to)
Package

cl-xmpp.

Methods
Method: request-subscription ((connection connection) to)
Source

cl-xmpp.lisp.

Generic Function: roster-add (connection jid name group)
Package

cl-xmpp.

Methods
Method: roster-add ((connection connection) jid name group)
Source

cl-xmpp.lisp.

Generic Function: roster-remove (connection jid)
Package

cl-xmpp.

Methods
Method: roster-remove ((connection connection) jid)
Source

cl-xmpp.lisp.

Generic Reader: server-stream (object)
Package

cl-xmpp.

Methods
Reader Method: server-stream ((connection connection))

automatically generated reader method

Source

cl-xmpp.lisp.

Target Slot

server-stream.

Generic Writer: (setf server-stream) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf server-stream) ((connection connection))

automatically generated writer method

Source

cl-xmpp.lisp.

Target Slot

server-stream.

Generic Function: session (connection)
Package

cl-xmpp.

Methods
Method: session ((connection connection))
Source

cl-xmpp.lisp.

Generic Reader: to (object)
Package

cl-xmpp.

Methods
Reader Method: to ((presence presence))

automatically generated reader method

Source

result.lisp.

Target Slot

to.

Reader Method: to ((message message))

automatically generated reader method

Source

result.lisp.

Target Slot

to.

Generic Writer: (setf to) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf to) ((presence presence))

automatically generated writer method

Source

result.lisp.

Target Slot

to.

Writer Method: (setf to) ((message message))

automatically generated writer method

Source

result.lisp.

Target Slot

to.

Generic Function: unsubscribe (connection to)
Package

cl-xmpp.

Methods
Method: unsubscribe ((connection connection) to)
Source

cl-xmpp.lisp.

Generic Reader: username (object)
Package

cl-xmpp.

Methods
Reader Method: username ((connection connection))

automatically generated reader method

Source

cl-xmpp.lisp.

Target Slot

username.

Generic Writer: (setf username) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf username) ((connection connection))

automatically generated writer method

Source

cl-xmpp.lisp.

Target Slot

username.

Generic Function: value (object)
Package

cl-xmpp.

Methods
Method: value (object)
Source

result.lisp.

Reader Method: value ((xml-attribute xml-attribute))

automatically generated reader method

Source

result.lisp.

Target Slot

value.

Generic Writer: (setf value) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf value) ((xml-attribute xml-attribute))

automatically generated writer method

Source

result.lisp.

Target Slot

value.

Generic Reader: xml-element (object)
Package

cl-xmpp.

Methods
Reader Method: xml-element ((event event))

automatically generated reader method

Source

result.lisp.

Target Slot

xml-element.

Generic Writer: (setf xml-element) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf xml-element) ((event event))

automatically generated writer method

Source

result.lisp.

Target Slot

xml-element.


5.1.5 Standalone methods

Method: print-object ((object connection) stream)

Print the object for the Lisp reader.

Source

cl-xmpp.lisp.

Method: print-object ((object presence) stream)

Print the object for the Lisp reader.

Source

result.lisp.

Method: print-object ((object xmpp-protocol-error) stream)

Print the object for the Lisp reader.

Source

result.lisp.

Method: print-object ((object xml-element) stream)

Print the object for the Lisp reader.

Source

result.lisp.

Method: print-object ((object xml-attribute) stream)

Print the object for the Lisp reader.

Source

result.lisp.

Method: print-object ((object roster) stream)

Print the object for the Lisp reader.

Source

result.lisp.

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

Print the object for the Lisp reader.

Source

result.lisp.

Method: print-object ((object contact) stream)

Print the object for the Lisp reader.

Source

result.lisp.


5.1.6 Classes

Class: connection

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.

Package

cl-xmpp.

Source

cl-xmpp.lisp.

Direct methods
Direct slots
Slot: server-stream
Initargs

:server-stream

Readers

server-stream.

Writers

(setf server-stream).

Slot: server-source
Readers

server-source.

Writers

(setf server-source).

Slot: stream-id

Stream ID attribute of the <stream>
element as gotten when we call BEGIN-XML-STREAM.

Initargs

:stream-id

Readers

stream-id.

Writers

(setf stream-id).

Slot: features

List of xml-element objects representing
the various features the host at the other end of the connection supports.

Initargs

:features

Readers

features.

Writers

(setf features).

Slot: mechanisms

List of xml-element objects representing
the various mechainsms the host at the other end of the connection will accept.

Initargs

:mechanisms

Readers

mechanisms.

Writers

(setf mechanisms).

Slot: jid-domain-part
Initargs

:jid-domain-part

Readers

jid-domain-part.

Writers

(setf jid-domain-part).

Slot: username
Initargs

:username

Readers

username.

Writers

(setf username).

Slot: hostname
Initform

cl-xmpp:*default-hostname*

Initargs

:hostname

Readers

hostname.

Writers

(setf hostname).

Slot: port
Initform

cl-xmpp::*default-port*

Initargs

:port

Readers

port.

Writers

(setf port).

Class: disco
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct subclasses
Direct methods
Direct slots
Slot: identities
Initargs

:identities

Readers

identities.

Writers

(setf identities).

Class: disco-info
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

disco.

Direct methods
Direct slots
Slot: features
Initargs

:features

Readers

features.

Writers

(setf features).

Class: disco-items
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

disco.

Direct methods
Direct slots
Slot: items
Initargs

:items

Readers

items.

Writers

(setf items).

Class: event
Package

cl-xmpp.

Source

result.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: xml-element
Initargs

:xml-element

Readers

xml-element.

Writers

(setf xml-element).

Class: identity-
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct methods
Direct slots
Slot: category
Initargs

:category

Readers

category.

Writers

(setf category).

Slot: type-
Initargs

:type-

Readers

type-.

Writers

(setf type-).

Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Class: item
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct methods
Direct slots
Slot: jid
Initargs

:jid

Readers

jid.

Writers

(setf jid).

Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: node
Initargs

:node

Readers

node.

Writers

(setf node).

Class: message
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct methods
Direct slots
Slot: to
Initargs

:to

Readers

to.

Writers

(setf to).

Slot: from
Initargs

:from

Readers

from.

Writers

(setf from).

Slot: body
Initform

""

Initargs

:body

Readers

body.

Writers

(setf body).

Slot: id
Initargs

:id

Readers

id.

Writers

(setf id).

Slot: type
Package

common-lisp.

Initargs

:type

Readers

type-.

Writers

(setf type-).

Class: presence
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct methods
Direct slots
Slot: to
Initargs

:to

Readers

to.

Writers

(setf to).

Slot: from
Initargs

:from

Readers

from.

Writers

(setf from).

Slot: show
Initargs

:show

Readers

show.

Writers

(setf show).

Slot: type-
Initargs

:type-

Readers

type-.

Writers

(setf type-).

Class: roster
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct methods
Direct slots
Slot: items
Initargs

:items

Readers

items.

Writers

(setf items).

Class: xml-attribute
Package

cl-xmpp.

Source

result.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: value
Initargs

:value

Readers

value.

Writers

(setf value).

Slot: node
Initargs

:node

Readers

node.

Writers

(setf node).

Class: xml-element
Package

cl-xmpp.

Source

result.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: node

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.

Initargs

:node

Readers

node.

Writers

(setf node).

Slot: attributes
Initargs

:attributes

Readers

attributes.

Writers

(setf attributes).

Slot: data
Initargs

:data

Readers

data.

Writers

(setf data).

Slot: elements
Initargs

:elements

Readers

elements.

Writers

(setf elements).

Class: xmpp-protocol-error
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct subclasses
Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

code.

Writers

(setf code).

Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Class: xmpp-protocol-error-auth
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

xmpp-protocol-error.

Class: xmpp-protocol-error-cancel
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

xmpp-protocol-error.

Class: xmpp-protocol-error-modify
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

xmpp-protocol-error.

Class: xmpp-protocol-error-wait
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

xmpp-protocol-error.


5.2 Internals


5.2.1 Special variables

Special Variable: *auth-methods*

Alist of method name to operator.

Operators must accept the following operands:

connection username password resource

Package

cl-xmpp.

Source

variable.lisp.

Special Variable: *default-port*
Package

cl-xmpp.

Source

variable.lisp.


5.2.2 Macros

Macro: fmt (string &rest args)
Package

cl-xmpp.

Source

utility.lisp.

Macro: with-xml-output ((connection) &body body)
Package

cl-xmpp.

Source

cl-xmpp.lisp.

Macro: with-xml-stream ((stream connection) &body body)

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.

Package

cl-xmpp.

Source

cl-xmpp.lisp.


5.2.3 Ordinary functions

Function: add-auth-method (name operator)
Package

cl-xmpp.

Source

utility.lisp.

Function: default-stanza-callback (stanza connection &key dom-repr)
Package

cl-xmpp.

Source

utility.lisp.

Function: digestify-string (string)
Package

cl-xmpp.

Source

utility.lisp.

Function: ensure-keyword (thing)

Makes a keyword except when it gets nil it just returns nil.

Package

cl-xmpp.

Source

utility.lisp.

Function: flatten (list)
Package

cl-xmpp.

Source

utility.lisp.

Function: get-auth-method (name)
Package

cl-xmpp.

Source

utility.lisp.

Function: get-error-data-code (code)
Package

cl-xmpp.

Source

result.lisp.

Function: get-error-data-name (name)
Package

cl-xmpp.

Source

result.lisp.

Function: list-auth-method-names ()
Package

cl-xmpp.

Source

utility.lisp.

Function: make-digest-password (stream-id password)
Package

cl-xmpp.

Source

utility.lisp.

Function: map-error-type-to-class (type)
Package

cl-xmpp.

Source

result.lisp.

Function: read-stanza (connection)
Package

cl-xmpp.

Source

cl-xmpp.lisp.

Function: vector-to-array (vector)
Package

cl-xmpp.

Source

utility.lisp.

Function: xml-output (stream string)

Write string to stream as a sequence of bytes and not characters.

Package

cl-xmpp.

Source

cl-xmpp.lisp.


5.2.4 Generic functions

Generic Function: %digest-md5-auth% (connection username password resource)
Package

cl-xmpp.

Methods
Method: %digest-md5-auth% ((connection connection) username password resource)
Source

cl-xmpp.lisp.

Generic Function: %plain-auth% (connection username password resource)
Package

cl-xmpp.

Methods
Method: %plain-auth% ((connection connection) username password resource)
Source

cl-xmpp.lisp.

Generic Function: cancel-registration (connection)
Package

cl-xmpp.

Methods
Method: cancel-registration ((connection connection))
Source

cl-xmpp.lisp.

Generic Reader: category (object)
Package

cl-xmpp.

Methods
Reader Method: category ((identity- identity-))

automatically generated reader method

Source

result.lisp.

Target Slot

category.

Generic Writer: (setf category) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf category) ((identity- identity-))

automatically generated writer method

Source

result.lisp.

Target Slot

category.

Generic Function: change-password (connection new-password)
Package

cl-xmpp.

Methods
Method: change-password ((connection connection) new-password)
Source

cl-xmpp.lisp.

Generic Reader: code (object)
Package

cl-xmpp.

Methods
Reader Method: code ((xmpp-protocol-error xmpp-protocol-error))

automatically generated reader method

Source

result.lisp.

Target Slot

code.

Generic Writer: (setf code) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf code) ((xmpp-protocol-error xmpp-protocol-error))

automatically generated writer method

Source

result.lisp.

Target Slot

code.

Generic Function: dom-to-event (connection objects)
Package

cl-xmpp.

Methods
Method: dom-to-event ((connection connection) (object xml-element))
Source

cl-xmpp.lisp.

Method: dom-to-event ((connection connection) (objects list))
Source

cl-xmpp.lisp.

Generic Reader: id (object)
Package

cl-xmpp.

Methods
Reader Method: id ((message message))

automatically generated reader method

Source

result.lisp.

Target Slot

id.

Generic Writer: (setf id) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf id) ((message message))

automatically generated writer method

Source

result.lisp.

Target Slot

id.

Generic Reader: jid-domain-part (object)
Package

cl-xmpp.

Methods
Reader Method: jid-domain-part ((connection connection))

automatically generated reader method

Source

cl-xmpp.lisp.

Target Slot

jid-domain-part.

Generic Writer: (setf jid-domain-part) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf jid-domain-part) ((connection connection))

automatically generated writer method

Source

cl-xmpp.lisp.

Target Slot

jid-domain-part.

Generic Function: make-disco-info (object)
Package

cl-xmpp.

Methods
Method: make-disco-info ((object xml-element))
Source

result.lisp.

Generic Function: make-disco-items (object)
Package

cl-xmpp.

Methods
Method: make-disco-items ((object xml-element))
Source

result.lisp.

Generic Function: make-error (object)
Package

cl-xmpp.

Methods
Method: make-error ((object xml-element))
Source

result.lisp.

Generic Function: make-feature (object)
Package

cl-xmpp.

Methods
Method: make-feature ((object xml-element))
Source

result.lisp.

Generic Function: make-identity (object)
Package

cl-xmpp.

Methods
Method: make-identity ((object xml-element))
Source

result.lisp.

Generic Function: make-item (object)
Package

cl-xmpp.

Methods
Method: make-item ((object xml-element))
Source

result.lisp.

Generic Function: make-roster (object)
Package

cl-xmpp.

Methods
Method: make-roster ((object xml-element))
Source

result.lisp.

Generic Function: parse-result (connection objects)
Package

cl-xmpp.

Methods
Method: parse-result ((connection connection) (node element))
Source

cl-xmpp.lisp.

Method: parse-result ((connection connection) (node node))
Source

cl-xmpp.lisp.

Method: parse-result ((connection connection) (node character-data))
Source

cl-xmpp.lisp.

Method: parse-result ((connection connection) (attribute attribute))
Source

cl-xmpp.lisp.

Method: parse-result ((connection connection) (document document))
Source

cl-xmpp.lisp.

Method: parse-result ((connection connection) (objects list))
Source

cl-xmpp.lisp.

Generic Reader: server-source (object)
Package

cl-xmpp.

Methods
Reader Method: server-source ((connection connection))

automatically generated reader method

Source

cl-xmpp.lisp.

Target Slot

server-source.

Generic Writer: (setf server-source) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf server-source) ((connection connection))

automatically generated writer method

Source

cl-xmpp.lisp.

Target Slot

server-source.

Generic Reader: show (object)
Package

cl-xmpp.

Methods
Reader Method: show ((presence presence))

automatically generated reader method

Source

result.lisp.

Target Slot

show.

Generic Writer: (setf show) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf show) ((presence presence))

automatically generated writer method

Source

result.lisp.

Target Slot

show.

Generic Reader: stream-id (object)
Generic Writer: (setf stream-id) (object)
Package

cl-xmpp.

Methods
Reader Method: stream-id ((connection connection))
Writer Method: (setf stream-id) ((connection connection))

Stream ID attribute of the <stream>
element as gotten when we call BEGIN-XML-STREAM.

Source

cl-xmpp.lisp.

Target Slot

stream-id.

Generic Reader: subscription (object)
Package

cl-xmpp.

Methods
Reader Method: subscription ((contact contact))

automatically generated reader method

Source

result.lisp.

Target Slot

subscription.

Generic Writer: (setf subscription) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf subscription) ((contact contact))

automatically generated writer method

Source

result.lisp.

Target Slot

subscription.

Generic Reader: type- (object)
Package

cl-xmpp.

Methods
Reader Method: type- ((identity- identity-))

automatically generated reader method

Source

result.lisp.

Target Slot

type-.

Reader Method: type- ((presence presence))

automatically generated reader method

Source

result.lisp.

Target Slot

type-.

Reader Method: type- ((message message))

automatically generated reader method

Source

result.lisp.

Target Slot

type.

Generic Writer: (setf type-) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf type-) ((identity- identity-))

automatically generated writer method

Source

result.lisp.

Target Slot

type-.

Writer Method: (setf type-) ((presence presence))

automatically generated writer method

Source

result.lisp.

Target Slot

type-.

Writer Method: (setf type-) ((message message))

automatically generated writer method

Source

result.lisp.

Target Slot

type.

Generic Reader: var (object)
Package

cl-xmpp.

Methods
Reader Method: var ((feature feature))

automatically generated reader method

Source

result.lisp.

Target Slot

var.

Generic Writer: (setf var) (object)
Package

cl-xmpp.

Methods
Writer Method: (setf var) ((feature feature))

automatically generated writer method

Source

result.lisp.

Target Slot

var.

Generic Function: xml-element-to-event (connection object name)
Package

cl-xmpp.

Methods
Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :message)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :presence)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) name)
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :success)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :|stream:features|)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :|stream:stream|)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :|stream:error|)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :error)))
Source

cl-xmpp.lisp.

Method: xml-element-to-event ((connection connection) (object xml-element) (name (eql :iq)))
Source

cl-xmpp.lisp.


5.2.5 Classes

Class: contact
Package

cl-xmpp.

Source

result.lisp.

Direct methods
Direct slots
Slot: jid
Initargs

:jid

Readers

jid.

Writers

(setf jid).

Slot: name
Initform

""

Initargs

:name

Readers

name.

Writers

(setf name).

Slot: subscription
Initargs

:subscription

Readers

subscription.

Writers

(setf subscription).

Class: feature
Package

cl-xmpp.

Source

result.lisp.

Direct superclasses

event.

Direct methods
Direct slots
Slot: var
Initform

""

Initargs

:var

Readers

var.

Writers

(setf var).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   L   M   N   P   R   S   T   U   V   W   X  
Index Entry  Section

%
%digest-md5-auth%: Private generic functions
%digest-md5-auth%: Private generic functions
%plain-auth%: Private generic functions
%plain-auth%: Private generic functions

(
(setf attributes): Public generic functions
(setf attributes): Public generic functions
(setf body): Public generic functions
(setf body): Public generic functions
(setf category): Private generic functions
(setf category): Private generic functions
(setf code): Private generic functions
(setf code): Private generic functions
(setf data): Public generic functions
(setf data): Public generic functions
(setf elements): Public generic functions
(setf elements): Public generic functions
(setf features): Public generic functions
(setf features): Public generic functions
(setf features): Public generic functions
(setf from): Public generic functions
(setf from): Public generic functions
(setf from): Public generic functions
(setf hostname): Public generic functions
(setf hostname): Public generic functions
(setf id): Private generic functions
(setf id): Private generic functions
(setf identities): Public generic functions
(setf identities): Public generic functions
(setf items): Public generic functions
(setf items): Public generic functions
(setf items): Public generic functions
(setf jid): Public generic functions
(setf jid): Public generic functions
(setf jid): Public generic functions
(setf jid-domain-part): Private generic functions
(setf jid-domain-part): Private generic functions
(setf mechanisms): Public generic functions
(setf mechanisms): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf node): Public generic functions
(setf node): Public generic functions
(setf node): Public generic functions
(setf node): Public generic functions
(setf port): Public generic functions
(setf port): Public generic functions
(setf server-source): Private generic functions
(setf server-source): Private generic functions
(setf server-stream): Public generic functions
(setf server-stream): Public generic functions
(setf show): Private generic functions
(setf show): Private generic functions
(setf stream-id): Private generic functions
(setf stream-id): Private generic functions
(setf subscription): Private generic functions
(setf subscription): Private generic functions
(setf to): Public generic functions
(setf to): Public generic functions
(setf to): Public generic functions
(setf type-): Private generic functions
(setf type-): Private generic functions
(setf type-): Private generic functions
(setf type-): Private generic functions
(setf username): Public generic functions
(setf username): Public generic functions
(setf value): Public generic functions
(setf value): Public generic functions
(setf var): Private generic functions
(setf var): Private generic functions
(setf xml-element): Public generic functions
(setf xml-element): Public generic functions

A
add-auth-method: Private ordinary functions
approve-subscription: Public generic functions
approve-subscription: Public generic functions
attributes: Public generic functions
attributes: Public generic functions
auth: Public generic functions
auth: Public generic functions
auth-requirements: Public generic functions
auth-requirements: Public generic functions

B
begin-xml-stream: Public generic functions
begin-xml-stream: Public generic functions
bind: Public generic functions
bind: Public generic functions
body: Public generic functions
body: Public generic functions

C
cancel-registration: Private generic functions
cancel-registration: Private generic functions
category: Private generic functions
category: Private generic functions
change-password: Private generic functions
change-password: Private generic functions
code: Private generic functions
code: Private generic functions
connect: Public ordinary functions
connectedp: Public generic functions
connectedp: Public generic functions

D
data: Public generic functions
data: Public generic functions
data: Public generic functions
default-stanza-callback: Private ordinary functions
deny/cancel-subscription: Public generic functions
deny/cancel-subscription: Public generic functions
digestify-string: Private ordinary functions
disconnect: Public generic functions
disconnect: Public generic functions
discover: Public generic functions
discover: Public generic functions
dom-to-event: Private generic functions
dom-to-event: Private generic functions
dom-to-event: Private generic functions

E
elements: Public generic functions
elements: Public generic functions
end-xml-stream: Public generic functions
end-xml-stream: Public generic functions
ensure-keyword: Private ordinary functions

F
feature-p: Public generic functions
feature-p: Public generic functions
feature-required-p: Public generic functions
feature-required-p: Public generic functions
features: Public generic functions
features: Public generic functions
features: Public generic functions
flatten: Private ordinary functions
fmt: Private macros
from: Public generic functions
from: Public generic functions
from: Public generic functions
Function, add-auth-method: Private ordinary functions
Function, connect: Public ordinary functions
Function, default-stanza-callback: Private ordinary functions
Function, digestify-string: Private ordinary functions
Function, ensure-keyword: Private ordinary functions
Function, flatten: Private ordinary functions
Function, get-auth-method: Private ordinary functions
Function, get-error-data-code: Private ordinary functions
Function, get-error-data-name: Private ordinary functions
Function, list-auth-method-names: Private ordinary functions
Function, make-digest-password: Private ordinary functions
Function, map-error-type-to-class: Private ordinary functions
Function, read-stanza: Private ordinary functions
Function, vector-to-array: Private ordinary functions
Function, xml-output: Private ordinary functions

G
Generic Function, %digest-md5-auth%: Private generic functions
Generic Function, %plain-auth%: Private generic functions
Generic Function, (setf attributes): Public generic functions
Generic Function, (setf body): Public generic functions
Generic Function, (setf category): Private generic functions
Generic Function, (setf code): Private generic functions
Generic Function, (setf data): Public generic functions
Generic Function, (setf elements): Public generic functions
Generic Function, (setf features): Public generic functions
Generic Function, (setf from): Public generic functions
Generic Function, (setf hostname): Public generic functions
Generic Function, (setf id): Private generic functions
Generic Function, (setf identities): Public generic functions
Generic Function, (setf items): Public generic functions
Generic Function, (setf jid): Public generic functions
Generic Function, (setf jid-domain-part): Private generic functions
Generic Function, (setf mechanisms): Public generic functions
Generic Function, (setf name): Public generic functions
Generic Function, (setf node): Public generic functions
Generic Function, (setf port): Public generic functions
Generic Function, (setf server-source): Private generic functions
Generic Function, (setf server-stream): Public generic functions
Generic Function, (setf show): Private generic functions
Generic Function, (setf stream-id): Private generic functions
Generic Function, (setf subscription): Private generic functions
Generic Function, (setf to): Public generic functions
Generic Function, (setf type-): Private generic functions
Generic Function, (setf username): Public generic functions
Generic Function, (setf value): Public generic functions
Generic Function, (setf var): Private generic functions
Generic Function, (setf xml-element): Public generic functions
Generic Function, approve-subscription: Public generic functions
Generic Function, attributes: Public generic functions
Generic Function, auth: Public generic functions
Generic Function, auth-requirements: Public generic functions
Generic Function, begin-xml-stream: Public generic functions
Generic Function, bind: Public generic functions
Generic Function, body: Public generic functions
Generic Function, cancel-registration: Private generic functions
Generic Function, category: Private generic functions
Generic Function, change-password: Private generic functions
Generic Function, code: Private generic functions
Generic Function, connectedp: Public generic functions
Generic Function, data: Public generic functions
Generic Function, deny/cancel-subscription: Public generic functions
Generic Function, disconnect: Public generic functions
Generic Function, discover: Public generic functions
Generic Function, dom-to-event: Private generic functions
Generic Function, elements: Public generic functions
Generic Function, end-xml-stream: Public generic functions
Generic Function, feature-p: Public generic functions
Generic Function, feature-required-p: Public generic functions
Generic Function, features: Public generic functions
Generic Function, from: Public generic functions
Generic Function, get-attribute: Public generic functions
Generic Function, get-element: Public generic functions
Generic Function, get-privacy-list: Public generic functions
Generic Function, get-privacy-lists: Public generic functions
Generic Function, get-roster: Public generic functions
Generic Function, handle: Public generic functions
Generic Function, hostname: Public generic functions
Generic Function, id: Private generic functions
Generic Function, identities: Public generic functions
Generic Function, items: Public generic functions
Generic Function, jid: Public generic functions
Generic Function, jid-domain-part: Private generic functions
Generic Function, make-disco-info: Private generic functions
Generic Function, make-disco-items: Private generic functions
Generic Function, make-error: Private generic functions
Generic Function, make-feature: Private generic functions
Generic Function, make-identity: Private generic functions
Generic Function, make-item: Private generic functions
Generic Function, make-roster: Private generic functions
Generic Function, mechanism-p: Public generic functions
Generic Function, mechanisms: Public generic functions
Generic Function, message: Public generic functions
Generic Function, name: Public generic functions
Generic Function, node: Public generic functions
Generic Function, parse-result: Private generic functions
Generic Function, port: Public generic functions
Generic Function, presence: Public generic functions
Generic Function, receive-stanza: Public generic functions
Generic Function, receive-stanza-loop: Public generic functions
Generic Function, register: Public generic functions
Generic Function, registration-requirements: Public generic functions
Generic Function, request-subscription: Public generic functions
Generic Function, roster-add: Public generic functions
Generic Function, roster-remove: Public generic functions
Generic Function, server-source: Private generic functions
Generic Function, server-stream: Public generic functions
Generic Function, session: Public generic functions
Generic Function, show: Private generic functions
Generic Function, stream-id: Private generic functions
Generic Function, subscription: Private generic functions
Generic Function, to: Public generic functions
Generic Function, type-: Private generic functions
Generic Function, unsubscribe: Public generic functions
Generic Function, username: Public generic functions
Generic Function, value: Public generic functions
Generic Function, var: Private generic functions
Generic Function, xml-element: Public generic functions
Generic Function, xml-element-to-event: Private generic functions
get-attribute: Public generic functions
get-attribute: Public generic functions
get-auth-method: Private ordinary functions
get-element: Public generic functions
get-element: Public generic functions
get-error-data-code: Private ordinary functions
get-error-data-name: Private ordinary functions
get-privacy-list: Public generic functions
get-privacy-list: Public generic functions
get-privacy-lists: Public generic functions
get-privacy-lists: Public generic functions
get-roster: Public generic functions
get-roster: Public generic functions

H
handle: Public generic functions
handle: Public generic functions
handle: Public generic functions
hostname: Public generic functions
hostname: Public generic functions

I
id: Private generic functions
id: Private generic functions
identities: Public generic functions
identities: Public generic functions
items: Public generic functions
items: Public generic functions
items: Public generic functions

J
jid: Public generic functions
jid: Public generic functions
jid: Public generic functions
jid-domain-part: Private generic functions
jid-domain-part: Private generic functions

L
list-auth-method-names: Private ordinary functions

M
Macro, fmt: Private macros
Macro, with-iq: Public macros
Macro, with-iq-query: Public macros
Macro, with-xml-output: Private macros
Macro, with-xml-stream: Private macros
make-digest-password: Private ordinary functions
make-disco-info: Private generic functions
make-disco-info: Private generic functions
make-disco-items: Private generic functions
make-disco-items: Private generic functions
make-error: Private generic functions
make-error: Private generic functions
make-feature: Private generic functions
make-feature: Private generic functions
make-identity: Private generic functions
make-identity: Private generic functions
make-item: Private generic functions
make-item: Private generic functions
make-roster: Private generic functions
make-roster: Private generic functions
map-error-type-to-class: Private ordinary functions
mechanism-p: Public generic functions
mechanism-p: Public generic functions
mechanisms: Public generic functions
mechanisms: Public generic functions
message: Public generic functions
message: Public generic functions
Method, %digest-md5-auth%: Private generic functions
Method, %plain-auth%: Private generic functions
Method, (setf attributes): Public generic functions
Method, (setf body): Public generic functions
Method, (setf category): Private generic functions
Method, (setf code): Private generic functions
Method, (setf data): Public generic functions
Method, (setf elements): Public generic functions
Method, (setf features): Public generic functions
Method, (setf features): Public generic functions
Method, (setf from): Public generic functions
Method, (setf from): Public generic functions
Method, (setf hostname): Public generic functions
Method, (setf id): Private generic functions
Method, (setf identities): Public generic functions
Method, (setf items): Public generic functions
Method, (setf items): Public generic functions
Method, (setf jid): Public generic functions
Method, (setf jid): Public generic functions
Method, (setf jid-domain-part): Private generic functions
Method, (setf mechanisms): Public generic functions
Method, (setf name): Public generic functions
Method, (setf name): Public generic functions
Method, (setf name): Public generic functions
Method, (setf name): Public generic functions
Method, (setf name): Public generic functions
Method, (setf name): Public generic functions
Method, (setf node): Public generic functions
Method, (setf node): Public generic functions
Method, (setf node): Public generic functions
Method, (setf port): Public generic functions
Method, (setf server-source): Private generic functions
Method, (setf server-stream): Public generic functions
Method, (setf show): Private generic functions
Method, (setf stream-id): Private generic functions
Method, (setf subscription): Private generic functions
Method, (setf to): Public generic functions
Method, (setf to): Public generic functions
Method, (setf type-): Private generic functions
Method, (setf type-): Private generic functions
Method, (setf type-): Private generic functions
Method, (setf username): Public generic functions
Method, (setf value): Public generic functions
Method, (setf var): Private generic functions
Method, (setf xml-element): Public generic functions
Method, approve-subscription: Public generic functions
Method, attributes: Public generic functions
Method, auth: Public generic functions
Method, auth-requirements: Public generic functions
Method, begin-xml-stream: Public generic functions
Method, bind: Public generic functions
Method, body: Public generic functions
Method, cancel-registration: Private generic functions
Method, category: Private generic functions
Method, change-password: Private generic functions
Method, code: Private generic functions
Method, connectedp: Public generic functions
Method, data: Public generic functions
Method, data: Public generic functions
Method, deny/cancel-subscription: Public generic functions
Method, disconnect: Public generic functions
Method, discover: Public generic functions
Method, dom-to-event: Private generic functions
Method, dom-to-event: Private generic functions
Method, elements: Public generic functions
Method, end-xml-stream: Public generic functions
Method, feature-p: Public generic functions
Method, feature-required-p: Public generic functions
Method, features: Public generic functions
Method, features: Public generic functions
Method, from: Public generic functions
Method, from: Public generic functions
Method, get-attribute: Public generic functions
Method, get-element: Public generic functions
Method, get-privacy-list: Public generic functions
Method, get-privacy-lists: Public generic functions
Method, get-roster: Public generic functions
Method, handle: Public generic functions
Method, handle: Public generic functions
Method, hostname: Public generic functions
Method, id: Private generic functions
Method, identities: Public generic functions
Method, items: Public generic functions
Method, items: Public generic functions
Method, jid: Public generic functions
Method, jid: Public generic functions
Method, jid-domain-part: Private generic functions
Method, make-disco-info: Private generic functions
Method, make-disco-items: Private generic functions
Method, make-error: Private generic functions
Method, make-feature: Private generic functions
Method, make-identity: Private generic functions
Method, make-item: Private generic functions
Method, make-roster: Private generic functions
Method, mechanism-p: Public generic functions
Method, mechanisms: Public generic functions
Method, message: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, name: Public generic functions
Method, node: Public generic functions
Method, node: Public generic functions
Method, node: Public generic functions
Method, parse-result: Private generic functions
Method, parse-result: Private generic functions
Method, parse-result: Private generic functions
Method, parse-result: Private generic functions
Method, parse-result: Private generic functions
Method, parse-result: Private generic functions
Method, port: Public generic functions
Method, presence: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, receive-stanza: Public generic functions
Method, receive-stanza-loop: Public generic functions
Method, register: Public generic functions
Method, registration-requirements: Public generic functions
Method, request-subscription: Public generic functions
Method, roster-add: Public generic functions
Method, roster-remove: Public generic functions
Method, server-source: Private generic functions
Method, server-stream: Public generic functions
Method, session: Public generic functions
Method, show: Private generic functions
Method, stream-id: Private generic functions
Method, subscription: Private generic functions
Method, to: Public generic functions
Method, to: Public generic functions
Method, type-: Private generic functions
Method, type-: Private generic functions
Method, type-: Private generic functions
Method, unsubscribe: Public generic functions
Method, username: Public generic functions
Method, value: Public generic functions
Method, value: Public generic functions
Method, var: Private generic functions
Method, xml-element: Public generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions
Method, xml-element-to-event: Private generic functions

N
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
name: Public generic functions
node: Public generic functions
node: Public generic functions
node: Public generic functions
node: Public generic functions

P
parse-result: Private generic functions
parse-result: Private generic functions
parse-result: Private generic functions
parse-result: Private generic functions
parse-result: Private generic functions
parse-result: Private generic functions
parse-result: Private generic functions
port: Public generic functions
port: Public generic functions
presence: Public generic functions
presence: Public generic functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

R
read-stanza: Private ordinary functions
receive-stanza: Public generic functions
receive-stanza: Public generic functions
receive-stanza-loop: Public generic functions
receive-stanza-loop: Public generic functions
register: Public generic functions
register: Public generic functions
registration-requirements: Public generic functions
registration-requirements: Public generic functions
request-subscription: Public generic functions
request-subscription: Public generic functions
roster-add: Public generic functions
roster-add: Public generic functions
roster-remove: Public generic functions
roster-remove: Public generic functions

S
server-source: Private generic functions
server-source: Private generic functions
server-stream: Public generic functions
server-stream: Public generic functions
session: Public generic functions
session: Public generic functions
show: Private generic functions
show: Private generic functions
stream-id: Private generic functions
stream-id: Private generic functions
subscription: Private generic functions
subscription: Private generic functions

T
to: Public generic functions
to: Public generic functions
to: Public generic functions
type-: Private generic functions
type-: Private generic functions
type-: Private generic functions
type-: Private generic functions

U
unsubscribe: Public generic functions
unsubscribe: Public generic functions
username: Public generic functions
username: Public generic functions

V
value: Public generic functions
value: Public generic functions
value: Public generic functions
var: Private generic functions
var: Private generic functions
vector-to-array: Private ordinary functions

W
with-iq: Public macros
with-iq-query: Public macros
with-xml-output: Private macros
with-xml-stream: Private macros

X
xml-element: Public generic functions
xml-element: Public generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-element-to-event: Private generic functions
xml-output: Private ordinary functions


A.3 Variables

Jump to:   *  
A   B   C   D   E   F   H   I   J   M   N   P   S   T   U   V   X  
Index Entry  Section

*
*auth-methods*: Private special variables
*debug-stream*: Public special variables
*default-hostname*: Public special variables
*default-port*: Private special variables
*errors*: Public special variables

A
attributes: Public classes

B
body: Public classes

C
category: Public classes
code: Public classes

D
data: Public classes

E
elements: Public classes

F
features: Public classes
features: Public classes
from: Public classes
from: Public classes

H
hostname: Public classes

I
id: Public classes
identities: Public classes
items: Public classes
items: Public classes

J
jid: Public classes
jid: Private classes
jid-domain-part: Public classes

M
mechanisms: Public classes

N
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Public classes
name: Private classes
node: Public classes
node: Public classes
node: Public classes

P
port: Public classes

S
server-source: Public classes
server-stream: Public classes
show: Public classes
Slot, attributes: Public classes
Slot, body: Public classes
Slot, category: Public classes
Slot, code: Public classes
Slot, data: Public classes
Slot, elements: Public classes
Slot, features: Public classes
Slot, features: Public classes
Slot, from: Public classes
Slot, from: Public classes
Slot, hostname: Public classes
Slot, id: Public classes
Slot, identities: Public classes
Slot, items: Public classes
Slot, items: Public classes
Slot, jid: Public classes
Slot, jid: Private classes
Slot, jid-domain-part: Public classes
Slot, mechanisms: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, name: Private classes
Slot, node: Public classes
Slot, node: Public classes
Slot, node: Public classes
Slot, port: Public classes
Slot, server-source: Public classes
Slot, server-stream: Public classes
Slot, show: Public classes
Slot, stream-id: Public classes
Slot, subscription: Private classes
Slot, to: Public classes
Slot, to: Public classes
Slot, type: Public classes
Slot, type-: Public classes
Slot, type-: Public classes
Slot, username: Public classes
Slot, value: Public classes
Slot, var: Private classes
Slot, xml-element: Public classes
Special Variable, *auth-methods*: Private special variables
Special Variable, *debug-stream*: Public special variables
Special Variable, *default-hostname*: Public special variables
Special Variable, *default-port*: Private special variables
Special Variable, *errors*: Public special variables
stream-id: Public classes
subscription: Private classes

T
to: Public classes
to: Public classes
type: Public classes
type-: Public classes
type-: Public classes

U
username: Public classes

V
value: Public classes
var: Private classes

X
xml-element: Public classes


A.4 Data types

Jump to:   C   D   E   F   I   M   P   R   S   U   V   X  
Index Entry  Section

C
cl-xmpp: The cl-xmpp system
cl-xmpp: The cl-xmpp package
cl-xmpp-system: The cl-xmpp-system package
cl-xmpp.asd: The cl-xmpp/cl-xmpp․asd file
cl-xmpp.lisp: The cl-xmpp/cl-xmpp․lisp file
Class, connection: Public classes
Class, contact: Private classes
Class, disco: Public classes
Class, disco-info: Public classes
Class, disco-items: Public classes
Class, event: Public classes
Class, feature: Private classes
Class, identity-: Public classes
Class, item: Public classes
Class, message: Public classes
Class, presence: Public classes
Class, roster: Public classes
Class, xml-attribute: Public classes
Class, xml-element: Public classes
Class, xmpp-protocol-error: Public classes
Class, xmpp-protocol-error-auth: Public classes
Class, xmpp-protocol-error-cancel: Public classes
Class, xmpp-protocol-error-modify: Public classes
Class, xmpp-protocol-error-wait: Public classes
connection: Public classes
contact: Private classes

D
disco: Public classes
disco-info: Public classes
disco-items: Public classes

E
event: Public classes

F
feature: Private classes
File, cl-xmpp.asd: The cl-xmpp/cl-xmpp․asd file
File, cl-xmpp.lisp: The cl-xmpp/cl-xmpp․lisp file
File, package.lisp: The cl-xmpp/package․lisp file
File, result.lisp: The cl-xmpp/result․lisp file
File, utility.lisp: The cl-xmpp/utility․lisp file
File, variable.lisp: The cl-xmpp/variable․lisp file

I
identity-: Public classes
item: Public classes

M
message: Public classes

P
Package, cl-xmpp: The cl-xmpp package
Package, cl-xmpp-system: The cl-xmpp-system package
package.lisp: The cl-xmpp/package․lisp file
presence: Public classes

R
result.lisp: The cl-xmpp/result․lisp file
roster: Public classes

S
System, cl-xmpp: The cl-xmpp system

U
utility.lisp: The cl-xmpp/utility․lisp file

V
variable.lisp: The cl-xmpp/variable․lisp file

X
xml-attribute: Public classes
xml-element: Public classes
xmpp-protocol-error: Public classes
xmpp-protocol-error-auth: Public classes
xmpp-protocol-error-cancel: Public classes
xmpp-protocol-error-modify: Public classes
xmpp-protocol-error-wait: Public classes