# HG changeset patch # User Matthew Wild # Date 1223130928 -3600 # Node ID 70ab5a1e574c1c1fcc9a354645869b152f106e73 # Parent 2f2c2375bf3e6093f75605e5efddb5ef5df635b0# Parent 4edb942e9dff21828ad0577582e9b746ac596d0f Merge docs from waqas diff -r 2f2c2375bf3e -r 70ab5a1e574c doc/session.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/session.txt Sat Oct 04 15:35:28 2008 +0100 @@ -0,0 +1,19 @@ + +Structure of a session: + + +session { + -- properties -- + conn -- the tcp connection + notopen -- true if stream has not been initiated, removed after receiving + priority -- the resource priority, default: 0 + type -- the connection type. Valid values include: + -- "c2s_unauthed" - connection has not been authenticated yet + -- "c2s" - from a local client to the server + username -- the node part of the client's jid (not defined before auth) + 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) + + -- methods -- + send(x) -- converts x to a string, and writes it to the connection +} \ No newline at end of file diff -r 2f2c2375bf3e -r 70ab5a1e574c doc/stanza.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/stanza.txt Sat Oct 04 15:35:28 2008 +0100 @@ -0,0 +1,20 @@ + +Structure of a stanza: + + +stanza { + --- properties --- + tags -- array of tags + + --- static methods --- + iq(attrs) -- + + --- read-only methods --- + reply -- return new stanza with attributes of current stanza + child_with_name(string name) -- return the first child of the current tag with the matching name + + --- write methods --- + tag(name, sttrs) -- create a new child of the current tag, and set the child as current + up() -- move to the parent of the current tag + text(string) -- append a new text node to the current tag +}