From f2a5d6b378701957c04649dcf693b72a133e201f Mon Sep 17 00:00:00 2001
From: Waqas Hussain <waqas20@gmail.com>
Date: Sat, 4 Oct 2008 19:32:02 +0500
Subject: Some notes of the stanza and session structures
---
doc/session.txt | 19 +++++++++++++++++++
doc/stanza.txt | 20 ++++++++++++++++++++
2 files changed, 39 insertions(+)
create mode 100644 doc/session.txt
create mode 100644 doc/stanza.txt
(limited to 'doc')
diff --git a/doc/session.txt b/doc/session.txt
new file mode 100644
index 00000000..3b4a4958
--- /dev/null
+++ b/doc/session.txt
@@ -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
diff --git a/doc/stanza.txt b/doc/stanza.txt
new file mode 100644
index 00000000..7f18ddd0
--- /dev/null
+++ b/doc/stanza.txt
@@ -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
+}
--
cgit v1.2.3