Some notes of the stanza and session structures

diff --git a/doc/session.txt b/doc/session.txt
new file mode 100644 (file)
index 0000000..3b4a495
--- /dev/null
+++ b/doc/session.txt
@@ -0,0 +1,19 @@
+\r
+Structure of a session:\r
+\r
+\r
+session {\r
+       -- properties --\r
+       conn -- the tcp connection\r
+       notopen -- true if stream has not been initiated, removed after receiving <stream:steam>\r
+       priority -- the resource priority, default: 0\r
+       type -- the connection type. Valid values include:\r
+                       -- "c2s_unauthed" - connection has not been authenticated yet\r
+                       -- "c2s" - from a local client to the server\r
+       username -- the node part of the client's jid (not defined before auth)\r
+       host -- the host part of the client's jid (not defined before stream initiation)\r
+       resource -- the resource part of the client's full jid (not defined before resource binding)\r
+       \r
+       -- methods --\r
+       send(x) -- converts x to a string, and writes it to the connection\r
+}
\ No newline at end of file

diff --git a/doc/stanza.txt b/doc/stanza.txt
new file mode 100644 (file)
index 0000000..7f18ddd
--- /dev/null
+++ b/doc/stanza.txt
@@ -0,0 +1,20 @@
+\r
+Structure of a stanza:\r
+\r
+\r
+stanza {\r
+       --- properties ---\r
+       tags -- array of tags\r
+       \r
+       --- static methods ---\r
+       iq(attrs) -- \r
+       \r
+       --- read-only methods ---\r
+       reply -- return new stanza with attributes of current stanza\r
+       child_with_name(string name) -- return the first child of the current tag with the matching name\r
+       \r
+       --- write methods ---\r
+       tag(name, sttrs) -- create a new child of the current tag, and set the child as current\r
+       up() -- move to the parent of the current tag\r
+       text(string) -- append a new text node to the current tag\r
+}\r