include/afb/afb-daemon-v2.h

   1 /*
   2  * Copyright (C) 2016, 2017, 2018 "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 "afb-daemon-itf-x1.h"
  21
  22 /**
  23  * @deprecated use bindings version 3
  24  *
  25  * Retrieves the common systemd's event loop of AFB
  26  */
  27 static inline struct sd_event *afb_daemon_get_event_loop_v2()
  28 {
  29         return afb_get_daemon_v2().itf->get_event_loop(afb_get_daemon_v2().closure);
  30 }
  31
  32 /**
  33  * @deprecated use bindings version 3
  34  *
  35  * Retrieves the common systemd's user/session d-bus of AFB
  36  */
  37 static inline struct sd_bus *afb_daemon_get_user_bus_v2()
  38 {
  39         return afb_get_daemon_v2().itf->get_user_bus(afb_get_daemon_v2().closure);
  40 }
  41
  42 /**
  43  * @deprecated use bindings version 3
  44  *
  45  * Retrieves the common systemd's system d-bus of AFB
  46  */
  47 static inline struct sd_bus *afb_daemon_get_system_bus_v2()
  48 {
  49         return afb_get_daemon_v2().itf->get_system_bus(afb_get_daemon_v2().closure);
  50 }
  51
  52 /**
  53  * @deprecated use bindings version 3
  54  *
  55  * Broadcasts widely the event of 'name' with the data 'object'.
  56  * 'object' can be NULL.
  57  *
  58  * For convenience, the function calls 'json_object_put' for 'object'.
  59  * Thus, in the case where 'object' should remain available after
  60  * the function returns, the function 'json_object_get' shall be used.
  61  *
  62  * Calling this function is only forbidden during preinit.
  63  *
  64  * Returns the count of clients that received the event.
  65  */
  66 static inline int afb_daemon_broadcast_event_v2(const char *name, struct json_object *object)
  67 {
  68         return afb_get_daemon_v2().itf->event_broadcast(afb_get_daemon_v2().closure, name, object);
  69 }
  70
  71 /**
  72  * @deprecated use bindings version 3
  73  *
  74  * Creates an event of 'name' and returns it.
  75  *
  76  * Calling this function is only forbidden during preinit.
  77  *
  78  * See afb_event_is_valid to check if there is an error.
  79  */
  80 static inline struct afb_event_x1 afb_daemon_make_event_v2(const char *name)
  81 {
  82         return afb_get_daemon_v2().itf->event_make(afb_get_daemon_v2().closure, name);
  83 }
  84
  85 /**
  86  * @deprecated use bindings version 3
  87  *
  88  * Send a message described by 'fmt' and following parameters
  89  * to the journal for the verbosity 'level'.
  90  *
  91  * 'file', 'line' and 'func' are indicators of position of the code in source files
  92  * (see macros __FILE__, __LINE__ and __func__).
  93  *
  94  * 'level' is defined by syslog standard:
  95  *      EMERGENCY         0        System is unusable
  96  *      ALERT             1        Action must be taken immediately
  97  *      CRITICAL          2        Critical conditions
  98  *      ERROR             3        Error conditions
  99  *      WARNING           4        Warning conditions
 100  *      NOTICE            5        Normal but significant condition
 101  *      INFO              6        Informational
 102  *      DEBUG             7        Debug-level messages
 103  */
 104 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)));
 105 static inline void afb_daemon_verbose_v2(int level, const char *file, int line, const char * func, const char *fmt, ...)
 106 {
 107         va_list args;
 108         va_start(args, fmt);
 109         afb_get_daemon_v2().itf->vverbose_v2(afb_get_daemon_v2().closure, level, file, line, func, fmt, args);
 110         va_end(args);
 111 }
 112
 113 /**
 114  * @deprecated use bindings version 3
 115  *
 116  * Get the root directory file descriptor. This file descriptor can
 117  * be used with functions 'openat', 'fstatat', ...
 118  *
 119  * Returns the file descriptor or -1 in case of error.
 120  */
 121 static inline int afb_daemon_rootdir_get_fd_v2()
 122 {
 123         return afb_get_daemon_v2().itf->rootdir_get_fd(afb_get_daemon_v2().closure);
 124 }
 125
 126 /**
 127  * @deprecated use bindings version 3
 128  *
 129  * Opens 'filename' within the root directory with 'flags' (see function openat)
 130  * using the 'locale' definition (example: "jp,en-US") that can be NULL.
 131  *
 132  * Returns the file descriptor or -1 in case of error.
 133  */
 134 static inline int afb_daemon_rootdir_open_locale_v2(const char *filename, int flags, const char *locale)
 135 {
 136         return afb_get_daemon_v2().itf->rootdir_open_locale(afb_get_daemon_v2().closure, filename, flags, locale);
 137 }
 138
 139 /**
 140  * @deprecated use bindings version 3
 141  *
 142  * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
 143  * in this thread (later) or in an other thread.
 144  * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
 145  * are executed in sequence in the order of there submission.
 146  * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
 147  * At first, the job is called with 0 as signum and the given argument.
 148  * The job is executed with the monitoring of its time and some signals like SIGSEGV and
 149  * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with
 150  * signum being the signal number (SIGALRM when timeout expired).
 151  *
 152  * Returns 0 in case of success or -1 in case of error.
 153  */
 154 static inline int afb_daemon_queue_job_v2(void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
 155 {
 156         return afb_get_daemon_v2().itf->queue_job(afb_get_daemon_v2().closure, callback, argument, group, timeout);
 157 }
 158
 159 /**
 160  * @deprecated use bindings version 3
 161  *
 162  * Retrieves the afb_req stored at 'sreq'.
 163  * Returns the stored request.
 164  * The count of reference is UNCHANGED, thus, the
 165  * function 'afb_req_unref' should be called on the result
 166  * after that the asynchronous reply if sent.
 167  */
 168 static inline struct afb_req_x1 afb_daemon_unstore_req_v2(struct afb_stored_req *sreq)
 169 {
 170         return afb_get_daemon_v2().itf->unstore_req(afb_get_daemon_v2().closure, sreq);
 171 }
 172
 173 /**
 174  * @deprecated use bindings version 3
 175  *
 176  * Tells that it requires the API of "name" to exist
 177  * and if 'initialized' is not null to be initialized.
 178  * Calling this function is only allowed within init.
 179  *
 180  * Returns 0 in case of success or -1 in case of error.
 181  */
 182 static inline int afb_daemon_require_api_v2(const char *name, int initialized)
 183 {
 184         return afb_get_daemon_v2().itf->require_api(afb_get_daemon_v2().closure, name, initialized);
 185 }
 186
 187 /**
 188  * @deprecated use bindings version 3
 189  *
 190  * Create an aliased name 'as_name' for the api 'name'.
 191  * Calling this function is only allowed within preinit.
 192  *
 193  * Returns 0 in case of success or -1 in case of error.
 194  */
 195 static inline int afb_daemon_add_alias_v2(const char *name, const char *as_name)
 196 {
 197         return afb_get_daemon_v2().itf->add_alias(afb_get_daemon_v2().closure, name, as_name);
 198 }
 199
 200 /**
 201  * @deprecated use bindings version 3
 202  *
 203  * Creates a new api of name 'api' with brief 'info'.
 204  *
 205  * Returns 0 in case of success or -1 in case of error.
 206  */
 207 static inline int afb_daemon_new_api_v2(
 208         const char *api,
 209         const char *info,
 210         int noconcurrency,
 211         int (*preinit)(void*, struct afb_api_x3 *),
 212         void *closure)
 213 {
 214         return -!(afb_get_daemon_v2().itf->new_api(afb_get_daemon_v2().closure, api, info, noconcurrency, preinit, closure));
 215 }
 216