aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthew Wild <mwild1@gmail.com>2008-10-05 01:31:27 +0100
committerMatthew Wild <mwild1@gmail.com>2008-10-05 01:31:27 +0100
commitc64b4c069eca2147e4296a7cf6ccc3801ea115bc (patch)
treee683a26eb42d8e70897031b21dce176b7e12caac /doc
parent8682a776e355aad58970c849dddb0884c3bb35ef (diff)
downloadprosody-c64b4c069eca2147e4296a7cf6ccc3801ea115bc.tar.gz
prosody-c64b4c069eca2147e4296a7cf6ccc3801ea115bc.zip
Docs
Diffstat (limited to 'doc')
-rw-r--r--doc/session.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/session.txt b/doc/session.txt
index 3b4a4958..82fe5ce4 100644
--- a/doc/session.txt
+++ b/doc/session.txt
@@ -6,14 +6,16 @@ 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)
+ full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding)
+ priority -- the resource priority, default: 0 (not defined before initial presence)
-- methods --
send(x) -- converts x to a string, and writes it to the connection
-} \ No newline at end of file
+ disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases
+}