Skip to content

mod_csi

Module Description

Enables XEP-0352: Client State Indication functionality.

The XEP doesn't require any specific server behaviour in response to CSI stanzas, there are only some suggestions. The implementation in MongooseIM will simply buffer all packets (up to a configured limit) when the session is "inactive" and will flush the buffer when it becomes "active" again.

Options

modules.mod_csi.buffer_max

  • Syntax: non-negative integer or the string "infinity"
  • Default: 20
  • Example: buffer_max = 40

Buffer size for messages queued when session was inactive.

Example Configuration

1
2
[modules.mod_csi]
  buffer_max = 40

Metrics

If you'd like to learn more about metrics in MongooseIM, please visit MongooseIM metrics page.

Name Type Description (when it gets incremented)
[Host, modCSIInactive] spiral A client becomes inactive.
[Host, modCSIActive] spiral A client becomes active.