aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lxmppd_core_offlinemessages.txt12
-rw-r--r--doc/lxmppd_core_rostermanager.txt9
-rw-r--r--doc/lxmppd_core_stanz_dispatch.txt27
-rw-r--r--doc/roster_format.txt1
-rw-r--r--doc/session.txt8
5 files changed, 5 insertions, 52 deletions
diff --git a/doc/lxmppd_core_offlinemessages.txt b/doc/lxmppd_core_offlinemessages.txt
deleted file mode 100644
index fa06a8e0..00000000
--- a/doc/lxmppd_core_offlinemessages.txt
+++ /dev/null
@@ -1,12 +0,0 @@
-lxmppd -> core -> offlinemessages.lua
- requires "util.datamanager"
- module "offlinemessage"
-
-function new(user, host, stanza)
- returns a function that stores the offline message it received
-
-This module offers storing of offline messages.
-
-Description: If the user that is supposed to get the message is not online,
- we store the messages locally as offline messages for later
- processing. \ No newline at end of file
diff --git a/doc/lxmppd_core_rostermanager.txt b/doc/lxmppd_core_rostermanager.txt
deleted file mode 100644
index 4f501158..00000000
--- a/doc/lxmppd_core_rostermanager.txt
+++ /dev/null
@@ -1,9 +0,0 @@
-lxmppd -> core -> rostermanager.lua
- requires "util.datamanager"
- module "rostermanager"
-
-function log(type, message)
- logs a message of type "rostermanager"
-
-function getroster(username, host)
- Retrieves the user's roster from the server and loads it with the datamanager \ No newline at end of file
diff --git a/doc/lxmppd_core_stanz_dispatch.txt b/doc/lxmppd_core_stanz_dispatch.txt
deleted file mode 100644
index 15bb730b..00000000
--- a/doc/lxmppd_core_stanz_dispatch.txt
+++ /dev/null
@@ -1,27 +0,0 @@
-lxmppd -> core -> stanza_dispatch
- requires "util.stanza"
- requires "core.usermanager"
-
-function init_stanza_dispatcher(session)
- Initialises the stanza dispatcher which handles different stanza according
- to their type and XML namespace, dispatching to required handlers.
-
- iq_handlers["jabber:iq:auth"]
- A list of handlers for "jabber:iq:auth" stanzas -- authentication
- (request) stanzas.
-
- function (stanza)
- If one of username, password and resource are missing then it ????.
- If not, then it validates the credentials and replies with the
- appropriate stanza.
-
- iq_handlers["jabber:iq:roster"]
- A list of handlers for "jabber:iq:roster" stanzas -- roster management
-
- function (stanza)
- Parses the type of stanza for roster management and does what is
- requested (roster retrieval, etc.)
-
- function (stanza)
- Validates the stanza and calls the required handler
-
diff --git a/doc/roster_format.txt b/doc/roster_format.txt
index 9094b5a1..132dbf4e 100644
--- a/doc/roster_format.txt
+++ b/doc/roster_format.txt
@@ -9,6 +9,7 @@ table roster_item {
string subscription = "none" | "to" | "from" | "both"
string name = Opaque string set by client. (optional)
set groups = a set of opaque strings set by the client
+ boolean ask = nil | "subscribe" - a value of true indicates subscription is pending
}
The roster is available as
diff --git a/doc/session.txt b/doc/session.txt
index e475e45b..fc6eec17 100644
--- a/doc/session.txt
+++ b/doc/session.txt
@@ -13,8 +13,8 @@ session {
host -- the host part of the client's jid (not defined before stream initiation)
resource -- the resource part of the client's full jid (not defined before resource binding)
full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding)
- priority -- the resource priority, default: 0 (not defined before initial presence)
- presence -- the last non-directed presence. initially nil.
+ priority -- the resource priority, default: 0
+ presence -- the last non-directed presence with no type attribute. initially nil. reset to nil on unavailable presence.
interested -- true if the resource requested the roster. Interested resources recieve roster updates. Initially nil.
roster -- the user's roster. Loaded as soon as the resource is bound (session becomes a connected resource).
@@ -24,5 +24,5 @@ session {
}
if session.full_jid (also session.roster and session.resource) then this is a "connected resource"
-if session.presence then this is an "available resource"
-if session.interested then this is an "interested resource"
+if session.presence then this is an "available resource" (all available resources are connected resources)
+if session.interested then this is an "interested resource" (all interested resources are connected resources)