2 * Copyright (C) 2016, 2017 "IoT.bzh"
3 * Author: José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include "afb-daemon-itf.h"
23 * Retrieves the common systemd's event loop of AFB
24 * 'daemon' MUST be the daemon given in interface when activating the binding.
26 static inline struct sd_event *afb_daemon_get_event_loop_v1(struct afb_daemon daemon)
28 return daemon.itf->get_event_loop(daemon.closure);
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.
35 static inline struct sd_bus *afb_daemon_get_user_bus_v1(struct afb_daemon daemon)
37 return daemon.itf->get_user_bus(daemon.closure);
41 * Retrieves the common systemd's system d-bus of AFB
42 * 'daemon' MUST be the daemon given in interface when activating the binding.
44 static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon daemon)
46 return daemon.itf->get_system_bus(daemon.closure);
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.
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.
58 * Calling this function is only forbidden during preinit.
60 * Returns the count of clients that received the event.
62 static inline int afb_daemon_broadcast_event_v1(struct afb_daemon daemon, const char *name, struct json_object *object)
64 return daemon.itf->event_broadcast(daemon.closure, name, object);
68 * Creates an event of 'name' and returns it.
69 * 'daemon' MUST be the daemon given in interface when activating the binding.
71 * Calling this function is only forbidden during preinit.
73 * See afb_event_is_valid to check if there is an error.
75 static inline struct afb_event afb_daemon_make_event_v1(struct afb_daemon daemon, const char *name)
77 return daemon.itf->event_make(daemon.closure, name);
81 * Send a message described by 'fmt' and following parameters
82 * to the journal for the verbosity 'level'.
84 * 'file' and 'line' are indicators of position of the code in source files
85 * (see macros __FILE__ and __LINE__).
87 * 'daemon' MUST be the daemon given in interface when activating the binding.
89 * 'level' is defined by syslog standard:
90 * EMERGENCY 0 System is unusable
91 * ALERT 1 Action must be taken immediately
92 * CRITICAL 2 Critical conditions
93 * ERROR 3 Error conditions
94 * WARNING 4 Warning conditions
95 * NOTICE 5 Normal but significant condition
96 * INFO 6 Informational
97 * DEBUG 7 Debug-level messages
99 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)));
100 static inline void afb_daemon_verbose_v1(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...)
104 daemon.itf->vverbose_v1(daemon.closure, level, file, line, fmt, args);
109 * Send a message described by 'fmt' and following parameters
110 * to the journal for the verbosity 'level'.
112 * 'file', 'line' and 'func' are indicators of position of the code in source files
113 * (see macros __FILE__, __LINE__ and __func__).
115 * 'daemon' MUST be the daemon given in interface when activating the binding.
117 * 'level' is defined by syslog standard:
118 * EMERGENCY 0 System is unusable
119 * ALERT 1 Action must be taken immediately
120 * CRITICAL 2 Critical conditions
121 * ERROR 3 Error conditions
122 * WARNING 4 Warning conditions
123 * NOTICE 5 Normal but significant condition
124 * INFO 6 Informational
125 * DEBUG 7 Debug-level messages
127 static inline void afb_daemon_verbose2_v1(struct afb_daemon daemon, int level, const char *file, int line, const char *func, const char *fmt, ...) __attribute__((format(printf, 6, 7)));
128 static inline void afb_daemon_verbose2_v1(struct afb_daemon daemon, int level, const char *file, int line, const char *func, const char *fmt, ...)
132 daemon.itf->vverbose_v2(daemon.closure, level, file, line, func, fmt, args);
137 * Get the root directory file descriptor. This file descriptor can
138 * be used with functions 'openat', 'fstatat', ...
140 static inline int afb_daemon_rootdir_get_fd_v1(struct afb_daemon daemon)
142 return daemon.itf->rootdir_get_fd(daemon.closure);
146 * Opens 'filename' within the root directory with 'flags' (see function openat)
147 * using the 'locale' definition (example: "jp,en-US") that can be NULL.
148 * Returns the file descriptor or -1 in case of error.
150 static inline int afb_daemon_rootdir_open_locale_v1(struct afb_daemon daemon, const char *filename, int flags, const char *locale)
152 return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale);
156 * Queue the job defined by 'callback' and 'argument' for being executed asynchronously
157 * in this thread (later) or in an other thread.
158 * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group')
159 * are executed in sequence in the order of there submission.
160 * If 'timeout' is not 0, it represent the maximum execution time for the job in seconds.
161 * At first, the job is called with 0 as signum and the given argument.
162 * The job is executed with the monitoring of its time and some signals like SIGSEGV and
163 * SIGFPE. When a such signal is catched, the job is terminated and reexecuted but with
164 * signum being the signal number (SIGALRM when timeout expired).
166 * Returns 0 in case of success or -1 in case of error.
168 static inline int afb_daemon_queue_job_v1(struct afb_daemon daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout)
170 return daemon.itf->queue_job(daemon.closure, callback, argument, group, timeout);
174 * Tells that it requires the API of "name" to exist
175 * and if 'initialized' is not null to be initialized.
176 * Calling this function is only allowed within init.
177 * Returns 0 in case of success or -1 in case of error.
179 static inline int afb_daemon_require_api_v1(struct afb_daemon daemon, const char *name, int initialized)
181 return daemon.itf->require_api(daemon.closure, name, initialized);
185 * Set the name of the API to 'name'.
186 * Calling this function is only allowed within preinit.
187 * Returns 0 in case of success or -1 in case of error.
189 static inline int afb_daemon_rename_api_v1(struct afb_daemon daemon, const char *name)
191 return daemon.itf->rename_api(daemon.closure, name);
194 static inline int afb_daemon_new_api_v1(
195 struct afb_daemon daemon,
199 int (*preinit)(void*, struct afb_dynapi *),
202 return daemon.itf->new_api(daemon.closure, api, info, noconcurrency, preinit, closure);