include/afb/afb-daemon-v1.h

   1 /*
   2  * Copyright (C) 2016, 2017 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 #include <stdarg.h>
  21
  22 /*
  23  * Retrieves the common systemd's event loop of AFB
  24  * 'daemon' MUST be the daemon given in interface when activating the binding.
  25  */
  26 static inline struct sd_event *afb_daemon_get_event_loop_v1(struct afb_daemon daemon)
  27 {
  28         return daemon.itf->get_event_loop(daemon.closure);
  29 }
  30
  31 /*
  32  * Retrieves the common systemd's user/session d-bus of AFB
  33  * 'daemon' MUST be the daemon given in interface when activating the binding.
  34  */
  35 static inline struct sd_bus *afb_daemon_get_user_bus_v1(struct afb_daemon daemon)
  36 {
  37         return daemon.itf->get_user_bus(daemon.closure);
  38 }
  39
  40 /*
  41  * Retrieves the common systemd's system d-bus of AFB
  42  * 'daemon' MUST be the daemon given in interface when activating the binding.
  43  */
  44 static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon daemon)
  45 {
  46         return daemon.itf->get_system_bus(daemon.closure);
  47 }
  48
  49 /*
  50  * Broadcasts widely the event of 'name' with the data 'object'.
  51  * 'object' can be NULL.
  52  * 'daemon' MUST be the daemon given in interface when activating the binding.
  53  *
  54  * For convenience, the function calls 'json_object_put' for 'object'.
  55  * Thus, in the case where 'object' should remain available after
  56  * the function returns, the function 'json_object_get' shall be used.
  57  *
  58  * Returns the count of clients that received the event.
  59  */
  60 static inline int afb_daemon_broadcast_event_v1(struct afb_daemon daemon, const char *name, struct json_object *object)
  61 {
  62         return daemon.itf->event_broadcast(daemon.closure, name, object);
  63 }
  64
  65 /*
  66  * Creates an event of 'name' and returns it.
  67  * 'daemon' MUST be the daemon given in interface when activating the binding.
  68  */
  69 static inline struct afb_event afb_daemon_make_event_v1(struct afb_daemon daemon, const char *name)
  70 {
  71         return daemon.itf->event_make(daemon.closure, name);
  72 }
  73
  74 /*
  75  * Send a message described by 'fmt' and following parameters
  76  * to the journal for the verbosity 'level'.
  77  * 'file' and 'line' are indicators of position of the code in source files.
  78  * 'daemon' MUST be the daemon given in interface when activating the binding.
  79  */
  80 static inline void afb_daemon_verbose_v1(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) __attribute__((format(printf, 5, 6)));
  81 static inline void afb_daemon_verbose_v1(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...)
  82 {
  83         va_list args;
  84         va_start(args, fmt);
  85         daemon.itf->vverbose_v1(daemon.closure, level, file, line, fmt, args);
  86         va_end(args);
  87 }
  88
  89 /*
  90  * Get the root directory file descriptor. This file descriptor can
  91  * be used with functions 'openat', 'fstatat', ...
  92  */
  93 static inline int afb_daemon_rootdir_get_fd_v1(struct afb_daemon daemon)
  94 {
  95         return daemon.itf->rootdir_get_fd(daemon.closure);
  96 }
  97
  98 /*
  99  * Opens 'filename' within the root directory with 'flags' (see function openat)
 100  * using the 'locale' definition (example: "jp,en-US") that can be NULL.
 101  * Returns the file descriptor or -1 in case of error.
 102  */
 103 static inline int afb_daemon_rootdir_open_locale_v1(struct afb_daemon daemon, const char *filename, int flags, const char *locale)
 104 {
 105         return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale);
 106 }
 107
 108 /*
 109  * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
 110  * in this thread (later) or in an other thread.
 111  * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
 112  * are executed in sequence in the order of there submission.
 113  * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
 114  * At first, the job is called with 0 as signum and the given argument.
 115  * The job is executed with the monitoring of its time and some signals like SIGSEGV and
 116  * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with
 117  * signum being the signal number (SIGALRM when timeout expired).
 118  *
 119  * Returns 0 in case of success or -1 in case of error.
 120  */
 121 static inline int afb_daemon_queue_job_v1(struct afb_daemon daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
 122 {
 123         return daemon.itf->queue_job(daemon.closure, callback, argument, group, timeout);
 124 }