aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/afb/afb-daemon-v1.h7
-rw-r--r--include/afb/afb-daemon-v2.h7
2 files changed, 14 insertions, 0 deletions
diff --git a/include/afb/afb-daemon-v1.h b/include/afb/afb-daemon-v1.h
index 8f5ed2f9..81cdb124 100644
--- a/include/afb/afb-daemon-v1.h
+++ b/include/afb/afb-daemon-v1.h
@@ -55,6 +55,8 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon daem
* Thus, in the case where 'object' should remain available after
* the function returns, the function 'json_object_get' shall be used.
*
+ * Calling this function is only forbidden during preinit.
+ *
* Returns the count of clients that received the event.
*/
static inline int afb_daemon_broadcast_event_v1(struct afb_daemon daemon, const char *name, struct json_object *object)
@@ -65,6 +67,10 @@ static inline int afb_daemon_broadcast_event_v1(struct afb_daemon daemon, const
/*
* Creates an event of 'name' and returns it.
* 'daemon' MUST be the daemon given in interface when activating the binding.
+ *
+ * Calling this function is only forbidden during preinit.
+ *
+ * See afb_event_is_valid to check if there is an error.
*/
static inline struct afb_event afb_daemon_make_event_v1(struct afb_daemon daemon, const char *name)
{
@@ -167,6 +173,7 @@ static inline int afb_daemon_queue_job_v1(struct afb_daemon daemon, void (*callb
/*
* Tells that it requires the API of "name" to exist
* and if 'initialized' is not null to be initialized.
+ * Calling this function is only allowed within init.
* Returns 0 in case of success or -1 in case of error.
*/
static inline int afb_daemon_require_api_v1(struct afb_daemon daemon, const char *name, int initialized)
diff --git a/include/afb/afb-daemon-v2.h b/include/afb/afb-daemon-v2.h
index 481d3dec..7ef085b0 100644
--- a/include/afb/afb-daemon-v2.h
+++ b/include/afb/afb-daemon-v2.h
@@ -51,6 +51,8 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v2()
* Thus, in the case where 'object' should remain available after
* the function returns, the function 'json_object_get' shall be used.
*
+ * Calling this function is only forbidden during preinit.
+ *
* Returns the count of clients that received the event.
*/
static inline int afb_daemon_broadcast_event_v2(const char *name, struct json_object *object)
@@ -60,6 +62,10 @@ static inline int afb_daemon_broadcast_event_v2(const char *name, struct json_ob
/*
* Creates an event of 'name' and returns it.
+ *
+ * Calling this function is only forbidden during preinit.
+ *
+ * See afb_event_is_valid to check if there is an error.
*/
static inline struct afb_event afb_daemon_make_event_v2(const char *name)
{
@@ -144,6 +150,7 @@ static inline struct afb_req afb_daemon_unstore_req_v2(struct afb_stored_req *sr
/*
* Tells that it requires the API of "name" to exist
* and if 'initialized' is not null to be initialized.
+ * Calling this function is only allowed within init.
* Returns 0 in case of success or -1 in case of error.
*/
static inline int afb_daemon_require_api_v2(const char *name, int initialized)