Thu, 23 Oct 2008 02:11:48 +0500
Updated session documentation
55
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
1 | |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
2 | Structure of a session: |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
3 | |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
4 | |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
5 | session { |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
6 | -- properties -- |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
7 | conn -- the tcp connection |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
8 | notopen -- true if stream has not been initiated, removed after receiving <stream:steam> |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
9 | type -- the connection type. Valid values include: |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
10 | -- "c2s_unauthed" - connection has not been authenticated yet |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
11 | -- "c2s" - from a local client to the server |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
12 | username -- the node part of the client's jid (not defined before auth) |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
13 | host -- the host part of the client's jid (not defined before stream initiation) |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
14 | resource -- the resource part of the client's full jid (not defined before resource binding) |
61 | 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) | |
115
db048883a522
Updated session documentation
Waqas Hussain <waqas20@gmail.com>
parents:
61
diff
changeset
|
17 | presence -- the last non-directed presence. initially nil. |
db048883a522
Updated session documentation
Waqas Hussain <waqas20@gmail.com>
parents:
61
diff
changeset
|
18 | interested -- true if the resource requested the roster. Interested resources recieve roster updates. Initially nil. |
55
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
19 | |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
20 | -- methods -- |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
21 | send(x) -- converts x to a string, and writes it to the connection |
61 | 22 | disconnect(x) -- Disconnect the user and clean up the session, best call sessionmanager.destroy_session() instead of this in most cases |
23 | } | |
115
db048883a522
Updated session documentation
Waqas Hussain <waqas20@gmail.com>
parents:
61
diff
changeset
|
24 | |
db048883a522
Updated session documentation
Waqas Hussain <waqas20@gmail.com>
parents:
61
diff
changeset
|
25 | A session is a "connected resource" |
db048883a522
Updated session documentation
Waqas Hussain <waqas20@gmail.com>
parents:
61
diff
changeset
|
26 | if session.presence then this is an "available resource" |
db048883a522
Updated session documentation
Waqas Hussain <waqas20@gmail.com>
parents:
61
diff
changeset
|
27 | if session.interested then this is an "interested resource" |