diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2016-05-27 23:43:24 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2016-05-27 23:43:24 +0200 |
| commit | eaab2fbbed4601415b5be052b39a0c0df11fdc38 (patch) | |
| tree | 706090ded2817ee44c042f3d1dc0d9698de19876 /include/afb/afb-plugin.h | |
| parent | 13b6d9bb553e996f76bc5f9bb1d9f7094e0e104b (diff) | |
improves documentation
Change-Id: Ia86f95ee852ca0cc419b2fe6e796621e358c8b29
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-plugin.h')
| -rw-r--r-- | include/afb/afb-plugin.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/include/afb/afb-plugin.h b/include/afb/afb-plugin.h index 3d16c7ad..2b065b08 100644 --- a/include/afb/afb-plugin.h +++ b/include/afb/afb-plugin.h @@ -212,6 +212,10 @@ static inline struct sd_bus *afb_daemon_get_system_bus(struct afb_daemon daemon) * Broadcasts widely the event of 'name' with the data 'object'. * 'object' can be NULL. * 'daemon' MUST be the daemon given in interface when activating the plugin. + * + * For conveniency, the function calls 'json_object_put' for 'object'. + * Thus, in the case where 'object' should remain available after + * the function returns, the function 'json_object_get' shall be used. */ static inline void afb_daemon_broadcast_event(struct afb_daemon daemon, const char *name, struct json_object *object) { |