From c64b4c069eca2147e4296a7cf6ccc3801ea115bc Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Sun, 5 Oct 2008 01:31:27 +0100 Subject: Docs --- doc/session.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'doc') 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 - 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 +} -- cgit v1.2.3