Changeset

61:7afc23a8114e

Docs
author Matthew Wild <mwild1@gmail.com>
date Sun, 05 Oct 2008 01:31:27 +0100
parents 59:9e1541b72522
children 62:9ec0d447cc9e
files doc/session.txt
diffstat 1 files changed, 4 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/session.txt	Sat Oct 04 19:24:43 2008 +0100
+++ b/doc/session.txt	Sun Oct 05 01:31:27 2008 +0100
@@ -6,14 +6,16 @@
 	-- 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
+}