prosody-modules
6b0db0f2d57a
mod_csi_battery_saver/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_csi_battery_saver/README.markdown @ 3633:6b0db0f2d57a

mod_csi_battery_saver: add compatibility with mod_csi_muc_priorities, make queue length configurable and update README
author tmolitor <thilo@eightysoft.de>
date Tue, 30 Jul 2019 01:46:57 +0200
parent 2754:d1aa5fc005f7
comparison
equal deleted inserted replaced
3632:83a68f5fde1d 3633:6b0db0f2d57a
1 --- 1 ---
2 description: CSI module to save battery on mobile devices 2 description: CSI module to save battery on mobile devices
3 labels:
4 - 'Stage-Alpha'
5 --- 3 ---
6 4
7 Please use this module instead of [mod_csi_pump] if you want timestamping, 5 Please use this module instead of [mod_csi_pump] if you want timestamping,
8 properly handled carbon copies, support for handling encrypted messages and 6 properly handled carbon copies, support for handling encrypted messages and
9 correctly handled smacks events. 7 correctly handled smacks events.
16 at the same time. This way, nothing is lost or reordered while still 14 at the same time. This way, nothing is lost or reordered while still
17 allowing for power usage savings by not requiring mobile clients to 15 allowing for power usage savings by not requiring mobile clients to
18 bring up their radio for unimportant stanzas. 16 bring up their radio for unimportant stanzas.
19 17
20 `IQ` stanzas, and `message` stanzas containing a body or being encrypted, 18 `IQ` stanzas, and `message` stanzas containing a body or being encrypted,
21 chat markers (see [XEP-0333]) and all nonzas are considered important. 19 chat markers (see [XEP-0333]) and all *nonzas* are considered important.
22 If the config option `csi_battery_saver_filter_muc` is set to true, 20 If the config option `csi_battery_saver_filter_muc` is set to true,
23 groupchat messages must set a subject or have the user's username or nickname 21 groupchat messages must set a subject or have the user's username or nickname
24 in their messages (or be encrypted) to count as "important", if this option 22 mentioned in the messages (or be encrypted) to count as "important".
25 is set to false (default), all groupchat messages having a body 23 **Warning:** you should only set this to true if your users can live with
26 or being encrypted are considered "important". 24 groupchat messages being delayed several minutes!
25 On the other hand if this option is set to false (*default*),
26 all groupchat messages having a body or being encrypted are considered "important".
27 In this case [mod_csi_muc_priorities] can be used to let user configure per groupchat
28 which of them are important for them (e.g. all messages having a body are important)
29 and which are not (e.g. only mentions and own messages are important).
30 If users don't change their settings, [mod_csi_muc_priorities] handles all groupchats
31 as important (see its docs for more information).
27 `Presence` stanzas are always considered not "important". 32 `Presence` stanzas are always considered not "important".
28 33
29 All buffered stanzas that allow timestamping are properly stamped to 34 All buffered stanzas that allow timestamping are properly stamped to
30 reflect their original send time, see [XEP-0203]. 35 reflect their original send time, see [XEP-0203].
31 36
32 Use with other CSI plugins such as [mod_throttle_presence], 37 Use with other CSI plugins such as [mod_throttle_presence],
33 [mod_filter_chatstates] or [mod_csi_pump] is *not* supported. 38 [mod_filter_chatstates], [mod_csi_simple] or [mod_csi_pump] is **not** supported.
39 Usage of [mod_csi_muc_priorities] is allowed (see configuration).
34 40
35 The internal stanza buffer of this module is hardcoded to 100 stanzas. 41 *Hint:* [mod_csi_muc_priorities] needs [mod_track_muc_joins] to function properly.
36 42
37 Configuration 43 Configuration
38 ============= 44 =============
39 45
40 Option Default Description 46 Option Default Description
41 ---------------------------------- ---------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 47 ---------------------------------- ---------- -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
42 `csi_battery_saver_filter_muc` false Controls whether all muc messages having a body should be considered as important (false) or only such containing the user's room nic (true). Warning: you should only set this to true if your users can live with muc messages being delayed several minutes. 48 `csi_battery_saver_filter_muc` false Controls whether all MUC messages having a body should be considered as important as long as [mod_csi_muc_priorities] doesn't configure them to be **not** important (false) or only such containing the user's room nic (true). **WARNING:** you should only set this to true if your users can live with muc messages being delayed several minutes.
49 `csi_battery_saver_queue_size` 256 Size of the stanza buffer used for the queue (if the queue is full a flush will be forced)
43 50
44 51
45 [f70c02c14161]: //hg.prosody.im/prosody-modules/raw-file/f70c02c14161/mod_smacks/mod_smacks.lua 52 [f70c02c14161]: //hg.prosody.im/prosody-modules/raw-file/f70c02c14161/mod_smacks/mod_smacks.lua