diff options
| author | Matthew Wild <mwild1@gmail.com> | 2008-10-04 15:35:28 +0100 |
|---|---|---|
| committer | Matthew Wild <mwild1@gmail.com> | 2008-10-04 15:35:28 +0100 |
| commit | 8200def62a6645dd5c510069a475196b9528f5e4 (patch) | |
| tree | 0d62f94e7d26896b0fa7efbca7f1ad2438b9351d /doc/session.txt | |
| parent | c322f6c01982f77c4bafa06c289cf59215a9f21f (diff) | |
| parent | f2a5d6b378701957c04649dcf693b72a133e201f (diff) | |
| download | prosody-8200def62a6645dd5c510069a475196b9528f5e4.tar.gz prosody-8200def62a6645dd5c510069a475196b9528f5e4.zip | |
Merge docs from waqas
Diffstat (limited to 'doc/session.txt')
| -rw-r--r-- | doc/session.txt | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/session.txt b/doc/session.txt new file mode 100644 index 00000000..3b4a4958 --- /dev/null +++ b/doc/session.txt @@ -0,0 +1,19 @@ +
+Structure of a session:
+
+
+session {
+ -- 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)
+
+ -- methods --
+ send(x) -- converts x to a string, and writes it to the connection
+}
\ No newline at end of file |