view mod_csi_battery_saver/README.markdown @ 2744:f70c02c14161

mod_smacks: Trigger event smacks-hibernation-end after queue resend This is more sensible and allows other modules to send out stanzas when handling this event without messing with the order of stanzas.
author tmolitor <thilo@eightysoft.de>
date Fri, 18 Aug 2017 00:56:38 +0200
parents 69248dcd7cff
children b62cec32680e
line wrap: on
line source

---
description: CSI module to save battery on mobile devices
labels:
- 'Stage-Alpha'
---

Please use this module instead of [mod_csi_pump] if you want timestamping,
properly handled carbon copies, support for handling encrypted messages and
correctly handled smacks events.

Stanzas are queued in a buffer until either an "important" stanza is
encountered or the buffer becomes full. Then all queued stanzas are sent
at the same time. This way, nothing is lost or reordered while still
allowing for power usage savings by not requiring mobile clients to
bring up their radio for unimportant stanzas.

`IQ` stanzas, and `message` stanzas containing a body or being encypted
and all nonzas are considered important. Groupchat messages must set a
subject or have the user's username or nickname in their messages to count
as "important". `Presence` stanzas are always not "important".

All buffered stanzas that allow timestamping are properly stamped to
reflect their original send time, see [XEP-0203].

Use with other CSI plugins such as [mod_throttle_presence],
[mod_filter_chatstates] or [mod_csi_pump] is *not* supported.

The internal stanza buffer of this module is hardcoded to 100 stanzas.