From 36df1aac32d6530fdaec7fcaa5f80c8d48599aba Mon Sep 17 00:00:00 2001 From: Waqas Hussain Date: Sun, 12 Oct 2008 17:38:17 +0500 Subject: Documented the roster object's structure --- doc/roster_format.txt | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/roster_format.txt (limited to 'doc') diff --git a/doc/roster_format.txt b/doc/roster_format.txt new file mode 100644 index 00000000..9094b5a1 --- /dev/null +++ b/doc/roster_format.txt @@ -0,0 +1,18 @@ + +This file documents the structure of the roster object. + +table roster { + [string bare_jid] = roster_item +} + +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 +} + +The roster is available as + hosts[host].sessions[username].roster +and a copy is made to session.roster for all sessions. + +All modifications to a roster should be done through the rostermanager. -- cgit v1.2.3 From aa212bcf2424521485e02110da93fd84bef743f7 Mon Sep 17 00:00:00 2001 From: Waqas Hussain Date: Thu, 23 Oct 2008 02:11:48 +0500 Subject: Updated session documentation --- doc/session.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc') diff --git a/doc/session.txt b/doc/session.txt index 82fe5ce4..389fb87c 100644 --- a/doc/session.txt +++ b/doc/session.txt @@ -14,8 +14,14 @@ session { 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. + interested -- true if the resource requested the roster. Interested resources recieve roster updates. Initially nil. -- methods -- send(x) -- converts x to a string, and writes it to the connection disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases } + +A session is a "connected resource" +if session.presence then this is an "available resource" +if session.interested then this is an "interested resource" -- cgit v1.2.3 From 9bcfe122c05a7082b83e8b0aa002c936e5b0ec8c Mon Sep 17 00:00:00 2001 From: Waqas Hussain Date: Thu, 23 Oct 2008 02:19:26 +0500 Subject: Updated and fixed session documentation --- doc/session.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/session.txt b/doc/session.txt index 389fb87c..e475e45b 100644 --- a/doc/session.txt +++ b/doc/session.txt @@ -16,12 +16,13 @@ session { priority -- the resource priority, default: 0 (not defined before initial presence) presence -- the last non-directed presence. initially nil. 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). -- methods -- send(x) -- converts x to a string, and writes it to the connection disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases } -A session is a "connected resource" +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" -- cgit v1.2.3