Changeset

6864:0129ffcaa7ab

mod_pep: Document data structures, so I don't have to spend time remembering every time I work on this module
author Matthew Wild <mwild1@gmail.com>
date Fri, 04 Sep 2015 11:26:51 +0100
parents 6863:88d54bec26b7
children 6865:20b0f0b48655
files plugins/mod_pep.lua
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/plugins/mod_pep.lua	Mon May 25 23:16:11 2015 +0100
+++ b/plugins/mod_pep.lua	Fri Sep 04 11:26:51 2015 +0100
@@ -17,9 +17,13 @@
 local calculate_hash = require "util.caps".calculate_hash;
 local core_post_stanza = prosody.core_post_stanza;
 
+-- Used as canonical 'empty table'
 local NULL = {};
+-- data[user_bare_jid][node] = item_stanza
 local data = {};
+--- recipients[user_bare_jid][contact_full_jid][subscribed_node] = true
 local recipients = {};
+-- hash_map[hash][subscribed_nodes] = true
 local hash_map = {};
 
 module.save = function()