Comparison

doc/session.txt @ 61:7afc23a8114e

Docs
author Matthew Wild <mwild1@gmail.com>
date Sun, 05 Oct 2008 01:31:27 +0100
parent 55:4edb942e9dff
child 115:db048883a522
comparison
equal deleted inserted replaced
59:9e1541b72522 61:7afc23a8114e
4 4
5 session { 5 session {
6 -- properties -- 6 -- properties --
7 conn -- the tcp connection 7 conn -- the tcp connection
8 notopen -- true if stream has not been initiated, removed after receiving <stream:steam> 8 notopen -- true if stream has not been initiated, removed after receiving <stream:steam>
9 priority -- the resource priority, default: 0
10 type -- the connection type. Valid values include: 9 type -- the connection type. Valid values include:
11 -- "c2s_unauthed" - connection has not been authenticated yet 10 -- "c2s_unauthed" - connection has not been authenticated yet
12 -- "c2s" - from a local client to the server 11 -- "c2s" - from a local client to the server
13 username -- the node part of the client's jid (not defined before auth) 12 username -- the node part of the client's jid (not defined before auth)
14 host -- the host part of the client's jid (not defined before stream initiation) 13 host -- the host part of the client's jid (not defined before stream initiation)
15 resource -- the resource part of the client's full jid (not defined before resource binding) 14 resource -- the resource part of the client's full jid (not defined before resource binding)
15 full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding)
16 priority -- the resource priority, default: 0 (not defined before initial presence)
16 17
17 -- methods -- 18 -- methods --
18 send(x) -- converts x to a string, and writes it to the connection 19 send(x) -- converts x to a string, and writes it to the connection
20 disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases
19 } 21 }