vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-05-02 00:40:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Adds documentation for OO recipients and operator functions

Browse source
This commit is contained in:
Simone Mainardi 2020-08-28 18:57:59 +02:00
parent fa00119b56
commit 34b53b8a9b
4 changed files with 31 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
scripts/lua/modules/recipients/recipients_lua_utils.lua
View file

@ -46,6 +46,7 @@ end
local all_instances_cache
-- @brief Caches all available recipient instances to avoid reloading them every time
local function get_all_instances_cache()
if not all_instances_cache then
all_instances_cache = all_recipient_instances_factory()
@ -56,6 +57,9 @@ end
-- ##############################################
-- @brief Dispatches a trigger `notification` to every available recipient (trigger notifications are generated in `alerts_api.trigger`)
-- @param notification A JSON string with all the alert information
-- @return true If the dispatching has been successfull, false otherwise
function recipients_lua_utils.dispatch_trigger_notification(notification)
local all_instances = get_all_instances_cache()
@ -68,6 +72,9 @@ end
-- ##############################################
-- @brief Dispatches a release `notification` to every available recipient (trigger notifications are generated in `alerts_api.release`)
-- @param notification A JSON string with all the alert information
-- @return true If the dispatching has been successfull, false otherwise
function recipients_lua_utils.dispatch_release_notification(notification)
local all_instances = get_all_instances_cache()
@ -80,6 +87,9 @@ end
-- ##############################################
-- @brief Dispatches a store `notification` to every available recipient (trigger notifications are generated in `alerts_api.store`)
-- @param notification A JSON string with all the alert information
-- @return true If the dispatching has been successfull, false otherwise
function recipients_lua_utils.dispatch_store_notification(notification)
local all_instances = get_all_instances_cache()
@ -92,6 +102,7 @@ end
-- ##############################################
-- @brief Processs notifications previously dispatched for every available recipient
function recipients_lua_utils.process_notifications(notification)
local all_instances = get_all_instances_cache()