Add 'afb_daemon_queue_job' for bindings

[src/app-framework-binder.git] / include / afb / afb-binding.h

diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h
index c8f96a3..9c84515 100644 (file)
--- a/include/afb/afb-binding.h
+++ b/include/afb/afb-binding.h
@@ -46,9 +46,9 @@
  * config mode
  */
 enum afb_mode {
-       AFB_MODE_LOCAL = 0,     /* run locally */
-       AFB_MODE_REMOTE,        /* run remotely */
-       AFB_MODE_GLOBAL         /* run either remotely or locally (DONT USE! reserved for future) */
+       AFB_MODE_LOCAL = 0,     /* run locally */
+       AFB_MODE_REMOTE,        /* run remotely */
+       AFB_MODE_GLOBAL         /* run either remotely or locally (DONT USE! reserved for future) */
 };
 
 /* declaration of features of libsystemd */
@@ -59,14 +59,15 @@ struct sd_bus;
  * Definition of the facilities provided by the daemon.
  */
 struct afb_daemon_itf {
-       int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */
-       struct sd_event *(*get_event_loop)(void *closure);      /* gets the common systemd's event loop */
-       struct sd_bus *(*get_user_bus)(void *closure);          /* gets the common systemd's user d-bus */
-       struct sd_bus *(*get_system_bus)(void *closure);        /* gets the common systemd's system d-bus */
-       void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args);
-       struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */
-       int (*rootdir_get_fd)(void *closure);
-       int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale);
+       int (*event_broadcast)(void *closure, const char *name, struct json_object *object); /* broadcasts evant 'name' with 'object' */
+       struct sd_event *(*get_event_loop)(void *closure);      /* gets the common systemd's event loop */
+       struct sd_bus *(*get_user_bus)(void *closure);          /* gets the common systemd's user d-bus */
+       struct sd_bus *(*get_system_bus)(void *closure);        /* gets the common systemd's system d-bus */
+       void (*vverbose)(void*closure, int level, const char *file, int line, const char *fmt, va_list args);
+       struct afb_event (*event_make)(void *closure, const char *name); /* creates an event of 'name' */
+       int (*rootdir_get_fd)(void *closure);
+       int (*rootdir_open_locale)(void *closure, const char *filename, int flags, const char *locale);
+       int (*queue_job)(void *closure, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout);
 };
 
 /*
@@ -74,8 +75,8 @@ struct afb_daemon_itf {
  * See also: afb_daemon_get_event_sender, afb_daemon_get_event_loop, afb_daemon_get_user_bus, afb_daemon_get_system_bus
  */
 struct afb_daemon {
-       const struct afb_daemon_itf *itf;       /* the interfacing functions */
-       void *closure;                          /* the closure when calling these functions */
+       const struct afb_daemon_itf *itf;       /* the interfacing functions */
+       void *closure;                          /* the closure when calling these functions */
 };
 
 /*
@@ -83,9 +84,9 @@ struct afb_daemon {
  */
 struct afb_binding_interface
 {
-       struct afb_daemon daemon;       /* access to the daemon facilies */
-       int verbosity;                  /* level of verbosity */
-       enum afb_mode mode;             /* run mode (local or remote) */
+       struct afb_daemon daemon;       /* access to the daemon facilies */
+       int verbosity;                  /* level of verbosity */
+       enum afb_mode mode;             /* run mode (local or remote) */
 };
 
 /*
@@ -193,4 +194,20 @@ static inline int afb_daemon_rootdir_open_locale(struct afb_daemon daemon, const
        return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale);
 }
 
-
+/*
+ * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
+ * in this thread (later) or in an other thread.
+ * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
+ * are executed in sequence in the order of there submission.
+ * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
+ * At first, the job is called with 0 as signum and the given argument.
+ * The job is executed with the monitoring of its time and some signals like SIGSEGV and
+ * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with
+ * signum being the signal number (SIGALRM when timeout expired).
+ *
+ * Returns 0 in case of success or -1 in case of error.
+ */
+static inline int afb_daemon_queue_job(struct afb_daemon daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
+{
+       return daemon.itf->queue_job(daemon.closure, callback, argument, group, timeout);
+}