mirror of
https://github.com/bjc/prosody.git
synced 2025-04-01 20:27:39 +03:00
Some notes of the stanza and session structures
This commit is contained in:
parent
b0c007ee60
commit
f2a5d6b378
2 changed files with 39 additions and 0 deletions
19
doc/session.txt
Normal file
19
doc/session.txt
Normal file
|
@ -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
|
||||
}
|
20
doc/stanza.txt
Normal file
20
doc/stanza.txt
Normal file
|
@ -0,0 +1,20 @@
|
|||
|
||||
Structure of a stanza:
|
||||
|
||||
|
||||
stanza {
|
||||
--- properties ---
|
||||
tags -- array of tags
|
||||
|
||||
--- static methods ---
|
||||
iq(attrs) --
|
||||
|
||||
--- read-only methods ---
|
||||
reply -- return new stanza with attributes of current stanza
|
||||
child_with_name(string name) -- return the first child of the current tag with the matching name
|
||||
|
||||
--- write methods ---
|
||||
tag(name, sttrs) -- create a new child of the current tag, and set the child as current
|
||||
up() -- move to the parent of the current tag
|
||||
text(string) -- append a new text node to the current tag
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue