Software /
code /
prosody
Changeset
55:4edb942e9dff
Some notes of the stanza and session structures
author | Waqas Hussain <waqas20@gmail.com> |
---|---|
date | Sat, 04 Oct 2008 19:32:02 +0500 |
parents | 51:5253c891a360 |
children | 56:70ab5a1e574c 58:85a93adef6f6 |
files | doc/session.txt doc/stanza.txt |
diffstat | 2 files changed, 39 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/session.txt Sat Oct 04 19:32:02 2008 +0500 @@ -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 <stream:steam> + 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
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/stanza.txt Sat Oct 04 19:32:02 2008 +0500 @@ -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 +}