Some notes of the stanza and session structures

[prosody.git] / doc / session.txt

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