Docs
authorMatthew Wild <mwild1@gmail.com>
Sun, 5 Oct 2008 00:31:27 +0000 (01:31 +0100)
committerMatthew Wild <mwild1@gmail.com>
Sun, 5 Oct 2008 00:31:27 +0000 (01:31 +0100)
doc/session.txt

index 3b4a4958fb521903ebe9b5e4ff72c228dd0a7136..82fe5ce420cb20623c2c10b842a3447f2c71d8f4 100644 (file)
@@ -6,14 +6,16 @@ session {
        -- 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
+       full_jid -- convenience for the above 3 as string in username@host/resource form (not defined before resource binding)\r
+       priority -- the resource priority, default: 0 (not defined before initial presence)\r
        \r
        -- methods --\r
        send(x) -- converts x to a string, and writes it to the connection\r
-}
\ 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\r
+}\r