From 25eeaeeff47fae317735d93cf85cef74d22bdb0c Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Sat, 4 Aug 2018 21:33:17 +0100 Subject: mod_pubsub: Add comment to document nodestore/itemstore methods --- plugins/mod_pubsub/mod_pubsub.lua | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'plugins') 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) -- cgit v1.2.3