Software /
code /
prosody
Annotate
doc/stanza.txt @ 11741:dcf38ac6a38c
net.server: Add a predrain callaback just before writes
Allows sneaking in things in the write buffer just before it's sent to
the network stack. For example ack requests, compression flushes or
other things that make sense to send after stanzas or other things.
This ensures any additional trailing data sent is included in the same
write, and possibly the same TCP packet. Other methods used such as
timers or nextTick might not have the same effect as it depends on
scheduling.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 16 Aug 2021 12:34:52 +0200 |
parent | 55:4edb942e9dff |
rev | line source |
---|---|
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 stanza: |
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 stanza { |
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 tags -- array of tags |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
8 |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
9 --- static methods --- |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
10 iq(attrs) -- |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
11 |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
12 --- read-only methods --- |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
13 reply -- return new stanza with attributes of current stanza |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
14 child_with_name(string name) -- return the first child of the current tag with the matching name |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
15 |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
16 --- write methods --- |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
17 tag(name, sttrs) -- create a new child of the current tag, and set the child as current |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
18 up() -- move to the parent of the current tag |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
19 text(string) -- append a new text node to the current tag |
4edb942e9dff
Some notes of the stanza and session structures
Waqas Hussain <waqas20@gmail.com>
parents:
diff
changeset
|
20 } |