include/afb/afb-daemon-v2.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  */
  25 static inline struct sd_event *afb_daemon_get_event_loop_v2()
  26 {
  27         return afb_get_daemon_v2().itf->get_event_loop(afb_get_daemon_v2().closure);
  28 }
  29
  30 /*
  31  * Retrieves the common systemd's user/session d-bus of AFB
  32  */
  33 static inline struct sd_bus *afb_daemon_get_user_bus_v2()
  34 {
  35         return afb_get_daemon_v2().itf->get_user_bus(afb_get_daemon_v2().closure);
  36 }
  37
  38 /*
  39  * Retrieves the common systemd's system d-bus of AFB
  40  */
  41 static inline struct sd_bus *afb_daemon_get_system_bus_v2()
  42 {
  43         return afb_get_daemon_v2().itf->get_system_bus(afb_get_daemon_v2().closure);
  44 }
  45
  46 /*
  47  * Broadcasts widely the event of 'name' with the data 'object'.
  48  * 'object' can be NULL.
  49  *
  50  * For convenience, the function calls 'json_object_put' for 'object'.
  51  * Thus, in the case where 'object' should remain available after
  52  * the function returns, the function 'json_object_get' shall be used.
  53  *
  54  * Returns the count of clients that received the event.
  55  */
  56 static inline int afb_daemon_broadcast_event_v2(const char *name, struct json_object *object)
  57 {
  58         return afb_get_daemon_v2().itf->event_broadcast(afb_get_daemon_v2().closure, name, object);
  59 }
  60
  61 /*
  62  * Creates an event of 'name' and returns it.
  63  */
  64 static inline struct afb_event afb_daemon_make_event_v2(const char *name)
  65 {
  66         return afb_get_daemon_v2().itf->event_make(afb_get_daemon_v2().closure, name);
  67 }
  68
  69 /*
  70  * Send a message described by 'fmt' and following parameters
  71  * to the journal for the verbosity 'level'.
  72  *
  73  * 'file', 'line' and 'func' are indicators of position of the code in source files
  74  * (see macros __FILE__, __LINE__ and __func__).
  75  *
  76  * 'level' is defined by syslog standard:
  77  *      EMERGENCY         0        System is unusable
  78  *      ALERT             1        Action must be taken immediately
  79  *      CRITICAL          2        Critical conditions
  80  *      ERROR             3        Error conditions
  81  *      WARNING           4        Warning conditions
  82  *      NOTICE            5        Normal but significant condition
  83  *      INFO              6        Informational
  84  *      DEBUG             7        Debug-level messages
  85  */
  86 static inline void afb_daemon_verbose_v2(int level, const char *file, int line, const char * func, const char *fmt, ...) __attribute__((format(printf, 5, 6)));
  87 static inline void afb_daemon_verbose_v2(int level, const char *file, int line, const char * func, const char *fmt, ...)
  88 {
  89         va_list args;
  90         va_start(args, fmt);
  91         afb_get_daemon_v2().itf->vverbose_v2(afb_get_daemon_v2().closure, level, file, line, func, fmt, args);
  92         va_end(args);
  93 }
  94
  95 /*
  96  * Get the root directory file descriptor. This file descriptor can
  97  * be used with functions 'openat', 'fstatat', ...
  98  */
  99 static inline int afb_daemon_rootdir_get_fd_v2()
 100 {
 101         return afb_get_daemon_v2().itf->rootdir_get_fd(afb_get_daemon_v2().closure);
 102 }
 103
 104 /*
 105  * Opens 'filename' within the root directory with 'flags' (see function openat)
 106  * using the 'locale' definition (example: "jp,en-US") that can be NULL.
 107  * Returns the file descriptor or -1 in case of error.
 108  */
 109 static inline int afb_daemon_rootdir_open_locale_v2(const char *filename, int flags, const char *locale)
 110 {
 111         return afb_get_daemon_v2().itf->rootdir_open_locale(afb_get_daemon_v2().closure, filename, flags, locale);
 112 }
 113
 114 /*
 115  * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
 116  * in this thread (later) or in an other thread.
 117  * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
 118  * are executed in sequence in the order of there submission.
 119  * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
 120  * At first, the job is called with 0 as signum and the given argument.
 121  * The job is executed with the monitoring of its time and some signals like SIGSEGV and
 122  * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with
 123  * signum being the signal number (SIGALRM when timeout expired).
 124  *
 125  * Returns 0 in case of success or -1 in case of error.
 126  */
 127 static inline int afb_daemon_queue_job_v2(void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
 128 {
 129         return afb_get_daemon_v2().itf->queue_job(afb_get_daemon_v2().closure, callback, argument, group, timeout);
 130 }