aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthew Wild <mwild1@gmail.com>2018-08-04 21:33:17 +0100
committerMatthew Wild <mwild1@gmail.com>2018-08-04 21:33:17 +0100
commit756c7750431fd55d35c53fbbda090cb3f35b99a2 (patch)
treee6e7e5a6ef057334f4468cf0afa86eb2b1a9b6c2
parent43c11955313ee52f25e81f0ff68db073be2d684b (diff)
downloadprosody-756c7750431fd55d35c53fbbda090cb3f35b99a2.tar.gz
prosody-756c7750431fd55d35c53fbbda090cb3f35b99a2.zip
mod_pubsub: Add comment to document nodestore/itemstore methods
-rw-r--r--plugins/mod_pubsub/mod_pubsub.lua14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/mod_pubsub/mod_pubsub.lua b/plugins/mod_pubsub/mod_pubsub.lua
index 83ff0897..113ee2b3 100644
--- a/plugins/mod_pubsub/mod_pubsub.lua
+++ b/plugins/mod_pubsub/mod_pubsub.lua
@@ -25,6 +25,20 @@ function handle_pubsub_iq(event)
return lib_pubsub.handle_pubsub_iq(event, service);
end
+-- An itemstore supports the following methods:
+-- items(): iterator over (id, item)
+-- get(id): return item with id
+-- set(id, item): set id to item
+-- clear(): clear all items
+-- resize(n): set new limit and trim oldest items
+-- tail(): return the latest item
+
+-- A nodestore supports the following methods:
+-- set(node_name, node_data)
+-- get(node_name)
+-- users(): iterator over (node_name)
+
+
local node_store = module:open_store(module.name.."_nodes");
local function create_simple_itemstore(node_config, node_name)