include/afb/afb-daemon-v2.h

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