Mercurial > prosody-modules
view mod_http_stats_stream/README.markdown @ 4936:a85efae90e21
mod_rest: Expand mapping of XEP-0045 join stanza
The previous 'join' mapping was apparently lost in translation when
swithing to datamapper, so might as well map some properties allowing
history control. Usually you probably want either zero history or
history since the last known time of being joined. Maybe that the former
should be the default?
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 30 Apr 2022 01:00:01 +0200 |
parents | bac3dae031ee |
children |
line wrap: on
line source
--- depends: - 'mod\_http' provides: - http --- # Introduction This module provides a streaming interface to [Prosodys internal statistics][doc:statistics] via [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events). ## Example ```js var evtSource = new EventSource("/stats_stream"); /* * An event with all current statistics in the form of a JSON object. * Normally sent only once, when first connected to the stream. */ evtSource.addEventListener("stats-full", function(e) { var initial_stats = JSON.parse(e.data); console.log(initial_stats); }, false); /* * An event containing only statistics that have changed since the last * 'stats-full' or 'stats-updated' event. */ evtSource.addEventListener("stats-updated", function(e) { var updated_stats = JSON.parse(e.data); console.log(updated_stats); }, false); ``` # Compatibility * Prosody \>= 0.11.0 * Trunk < [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)