Software / code / prosody-modules
Comparison
mod_csi_battery_saver/README.markdown @ 2741:69248dcd7cff
mod_csi_battery_saver: Fix interaction with smacks hibernation
This should fix a bug that caused the module to be deactivated
on smacks resume.
Also update the readme accordingly,
| author | tmolitor <thilo@eightysoft.de> |
|---|---|
| date | Thu, 17 Aug 2017 21:21:23 +0200 |
| parent | 2606:538c54d2dab3 |
| child | 2745:b62cec32680e |
comparison
equal
deleted
inserted
replaced
| 2737:f43c77c69a8a | 2741:69248dcd7cff |
|---|---|
| 1 --- | 1 --- |
| 2 description: CSI module to save battery on mobile devices | 2 description: CSI module to save battery on mobile devices |
| 3 labels: | 3 labels: |
| 4 - 'Stage-Alpha' | 4 - 'Stage-Alpha' |
| 5 --- | 5 --- |
| 6 | |
| 7 Please use this module instead of [mod_csi_pump] if you want timestamping, | |
| 8 properly handled carbon copies, support for handling encrypted messages and | |
| 9 correctly handled smacks events. | |
| 6 | 10 |
| 7 Stanzas are queued in a buffer until either an "important" stanza is | 11 Stanzas are queued in a buffer until either an "important" stanza is |
| 8 encountered or the buffer becomes full. Then all queued stanzas are sent | 12 encountered or the buffer becomes full. Then all queued stanzas are sent |
| 9 at the same time. This way, nothing is lost or reordered while still | 13 at the same time. This way, nothing is lost or reordered while still |
| 10 allowing for power usage savings by not requiring mobile clients to | 14 allowing for power usage savings by not requiring mobile clients to |
| 11 bring up their radio for unimportant stanzas. | 15 bring up their radio for unimportant stanzas. |
| 12 | 16 |
| 13 `IQ` stanzas, smacks "stanzas" and `message` stanzas containing a body are | 17 `IQ` stanzas, and `message` stanzas containing a body or being encypted |
| 14 considered important. Groupchat messages must set a subject or have | 18 and all nonzas are considered important. Groupchat messages must set a |
| 15 the user's username or nickname in their messages to count as "important". | 19 subject or have the user's username or nickname in their messages to count |
| 16 `Presence` stanzas are not "important". | 20 as "important". `Presence` stanzas are always not "important". |
| 17 | 21 |
| 18 All buffered stanzas that allow timestamping are properly stamped to | 22 All buffered stanzas that allow timestamping are properly stamped to |
| 19 reflect their original send time, see [XEP-0203]. | 23 reflect their original send time, see [XEP-0203]. |
| 20 | 24 |
| 21 Use with other CSI plugins such as [mod_throttle_presence], | 25 Use with other CSI plugins such as [mod_throttle_presence], |
| 22 [mod_filter_chatstates] or [mod_csi_pump] is *not* supported. | 26 [mod_filter_chatstates] or [mod_csi_pump] is *not* supported. |
| 23 Please use this module instead of [mod_csi_pump] if you want timestamping | |
| 24 and properly handled carbon copies. | |
| 25 | 27 |
| 26 The internal stanza buffer of this module is hardcoded to 100 stanzas. | 28 The internal stanza buffer of this module is hardcoded to 100 stanzas. |