Skip to content

mod_caps

Module description

This module provides a presence-based mechanism for exchanging information about entity capabilities as defined in XEP-0115: Entity Capabilities and XEP-0390: Entity Capabilities 2.0. By storing the clients' capabilities, it allows filtered notifications in PEP. It is not this module's responsibility to intercept and answer disco requests routed between clients.

Options

modules.mod_caps.backend

  • Syntax: string; only "cets" is allowed.
  • Default: "cets"
  • Example: backend = "cets"

The backend used to store entity capabilities. Currently only CETS is supported.

Warning

The corresponding internal database has to be enabled.

modules.mod_caps.iq_response_timeout

  • Syntax: positive integer (milliseconds)
  • Default: 5000 (5 seconds)
  • Example: iq_response_timeout = 10_000

Maximum waiting time for the client's response to a service discovery query.

modules.mod_caps.versions

  • Syntax: non-empty list of unique strings, each one of "v1" or "v2"
  • Default: ["v1", "v2"]
  • Example: versions = ["v2"]

Capability protocol versions accepted and advertised by the server. "v1" corresponds to XEP-0115, and "v2" corresponds to XEP-0390. Their order is the order in which client capabilities are processed and server capabilities are advertised.

Example Configuration

1
2
3
[modules.mod_caps]
  iq_response_timeout = 10_000
  versions = ["v2"]