diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/.directory | 3 | ||||
| -rw-r--r-- | doc/lxmppd_core_offlinemessages.txt | 12 | ||||
| -rw-r--r-- | doc/lxmppd_core_rostermanager.txt | 9 | ||||
| -rw-r--r-- | doc/lxmppd_core_stanz_dispatch.txt | 26 | ||||
| -rw-r--r-- | doc/names.txt | 42 | ||||
| -rw-r--r-- | doc/roster_format.txt | 19 | ||||
| -rw-r--r-- | doc/session.txt | 9 |
7 files changed, 61 insertions, 59 deletions
diff --git a/doc/.directory b/doc/.directory deleted file mode 100644 index 2bcc45d8..00000000 --- a/doc/.directory +++ /dev/null @@ -1,3 +0,0 @@ -[Dolphin] -Timestamp=2008,9,15,21,41,28 -ViewMode=1 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 c76844e9..00000000 --- a/doc/lxmppd_core_stanz_dispatch.txt +++ /dev/null @@ -1,26 +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/names.txt b/doc/names.txt index ced293bb..7a6ab1e9 100644 --- a/doc/names.txt +++ b/doc/names.txt @@ -1,9 +1,35 @@ -lxmppd - ... -dia - Greek, 'through', pronounced "dee-ah", root of "dialogue" -metaphor - An imaginative comparison between two actions/objects etc which is not literally applicable. -minstrel - Itinerant medieval musician/singer/story teller/poet. -parody - Imitation of a poem or another poet's style for comic/satiric effect. -poesy - Archaic word for poetry. -Xinshi - Chinese poetic term which literally means 'new poetry'. +lxmppd - ... +dia - Greek, 'through', pronounced "dee-ah", root of "dialogue" +metaphor - An imaginative comparison between two actions/objects etc which is not literally applicable. +minstrel - Itinerant medieval musician/singer/story teller/poet. +parody - Imitation of a poem or another poet's style for comic/satiric effect. +poesy - Archaic word for poetry. +Xinshi - Chinese poetic term which literally means 'new poetry'. +polylogue - Many conversations -polylogue- Many conversations +Thorns thought of: + poe - Derived from "poetry" + poezie - Romanian for "poesy" and "poem" + Elain - Just a cool name + Elane - A variation + Eclaire - Idem (French) + Adel - Random + Younha - Read as "yuna" + Quezacotl - Mayan gods -> google for correct form and pronounciation + Carbuncle - FF8 Guardian Force ^^ + Protos - Mars satellite + mins - Derived from minstrel + diapoe - gr. dia + poesy/poetry + xinshi - I like it for a name just like that + loom - The first application I run on the first day of using a computer + Lory - Another name I happen to like + Loki - Nordic god of mischief, IIRC + Luna - Probably taken but I think worth mentioning + Coreo - Random thought + Miria - Also random + Lora - Idem + Kraken - :P + Nebula - . + + + diff --git a/doc/roster_format.txt b/doc/roster_format.txt new file mode 100644 index 00000000..132dbf4e --- /dev/null +++ b/doc/roster_format.txt @@ -0,0 +1,19 @@ +
+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
+ boolean ask = nil | "subscribe" - a value of true indicates subscription is pending
+}
+
+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.
diff --git a/doc/session.txt b/doc/session.txt index 82fe5ce4..fc6eec17 100644 --- a/doc/session.txt +++ b/doc/session.txt @@ -13,9 +13,16 @@ 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)
+ 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).
-- 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
}
+
+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" (all available resources are connected resources)
+if session.interested then this is an "interested resource" (all interested resources are connected resources)
|