X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-daemon-v1.h;h=e10710bdf73c0cedc58d58ac5cade86801ccbc2e;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=84095e040691ac1ccda85756292ea741ec82b2d6;hpb=95c29ef579d6320a721f96d7146efd10f74a201b;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-daemon-v1.h b/include/afb/afb-daemon-v1.h index 84095e04..e10710bd 100644 --- a/include/afb/afb-daemon-v1.h +++ b/include/afb/afb-daemon-v1.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016, 2017 "IoT.bzh" + * Copyright (C) 2015-2020 "IoT.bzh" * Author: José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -17,36 +17,47 @@ #pragma once -#include +#include "afb-daemon-itf-x1.h" -/* +/** @addtogroup AFB_DAEMON + * @{ */ + +/** + * @deprecated use bindings version 3 + * * Retrieves the common systemd's event loop of AFB * 'daemon' MUST be the daemon given in interface when activating the binding. */ -static inline struct sd_event *afb_daemon_get_event_loop_v1(struct afb_daemon daemon) +static inline struct sd_event *afb_daemon_get_event_loop_v1(struct afb_daemon_x1 daemon) { return daemon.itf->get_event_loop(daemon.closure); } -/* +/** + * @deprecated use bindings version 3 + * * Retrieves the common systemd's user/session d-bus of AFB * 'daemon' MUST be the daemon given in interface when activating the binding. */ -static inline struct sd_bus *afb_daemon_get_user_bus_v1(struct afb_daemon daemon) +static inline struct sd_bus *afb_daemon_get_user_bus_v1(struct afb_daemon_x1 daemon) { return daemon.itf->get_user_bus(daemon.closure); } -/* +/** + * @deprecated use bindings version 3 + * * Retrieves the common systemd's system d-bus of AFB * 'daemon' MUST be the daemon given in interface when activating the binding. */ -static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon daemon) +static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon_x1 daemon) { return daemon.itf->get_system_bus(daemon.closure); } -/* +/** + * @deprecated use bindings version 3 + * * Broadcasts widely the event of 'name' with the data 'object'. * 'object' can be NULL. * 'daemon' MUST be the daemon given in interface when activating the binding. @@ -55,30 +66,53 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v1(struct afb_daemon daem * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. * - * Returns the count of clients that received the event. + * Calling this function is only forbidden during preinit. + * + * Returns 0 in case of success or -1 in case of error */ -static inline int afb_daemon_broadcast_event_v1(struct afb_daemon daemon, const char *name, struct json_object *object) +static inline int afb_daemon_broadcast_event_v1(struct afb_daemon_x1 daemon, const char *name, struct json_object *object) { return daemon.itf->event_broadcast(daemon.closure, name, object); } -/* +/** + * @deprecated use bindings version 3 + * * Creates an event of 'name' and returns it. * 'daemon' MUST be the daemon given in interface when activating the binding. + * + * Calling this function is only forbidden during preinit. + * + * See afb_event_is_valid to check if there is an error. */ -static inline struct afb_event afb_daemon_make_event_v1(struct afb_daemon daemon, const char *name) +static inline struct afb_event_x1 afb_daemon_make_event_v1(struct afb_daemon_x1 daemon, const char *name) { return daemon.itf->event_make(daemon.closure, name); } -/* +/** + * @deprecated use bindings version 3 + * * Send a message described by 'fmt' and following parameters * to the journal for the verbosity 'level'. - * 'file' and 'line' are indicators of position of the code in source files. + * + * 'file' and 'line' are indicators of position of the code in source files + * (see macros __FILE__ and __LINE__). + * * 'daemon' MUST be the daemon given in interface when activating the binding. + * + * 'level' is defined by syslog standard: + * EMERGENCY 0 System is unusable + * ALERT 1 Action must be taken immediately + * CRITICAL 2 Critical conditions + * ERROR 3 Error conditions + * WARNING 4 Warning conditions + * NOTICE 5 Normal but significant condition + * INFO 6 Informational + * DEBUG 7 Debug-level messages */ -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))); -static inline void afb_daemon_verbose_v1(struct afb_daemon daemon, int level, const char *file, int line, const char *fmt, ...) +static inline void afb_daemon_verbose_v1(struct afb_daemon_x1 daemon, int level, const char *file, int line, const char *fmt, ...) __attribute__((format(printf, 5, 6))); +static inline void afb_daemon_verbose_v1(struct afb_daemon_x1 daemon, int level, const char *file, int line, const char *fmt, ...) { va_list args; va_start(args, fmt); @@ -86,26 +120,64 @@ static inline void afb_daemon_verbose_v1(struct afb_daemon daemon, int level, co va_end(args); } -/* +/** + * @deprecated use bindings version 3 + * + * Send a message described by 'fmt' and following parameters + * to the journal for the verbosity 'level'. + * + * 'file', 'line' and 'func' are indicators of position of the code in source files + * (see macros __FILE__, __LINE__ and __func__). + * + * 'daemon' MUST be the daemon given in interface when activating the binding. + * + * 'level' is defined by syslog standard: + * EMERGENCY 0 System is unusable + * ALERT 1 Action must be taken immediately + * CRITICAL 2 Critical conditions + * ERROR 3 Error conditions + * WARNING 4 Warning conditions + * NOTICE 5 Normal but significant condition + * INFO 6 Informational + * DEBUG 7 Debug-level messages + */ +static inline void afb_daemon_verbose2_v1(struct afb_daemon_x1 daemon, int level, const char *file, int line, const char *func, const char *fmt, ...) __attribute__((format(printf, 6, 7))); +static inline void afb_daemon_verbose2_v1(struct afb_daemon_x1 daemon, int level, const char *file, int line, const char *func, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + daemon.itf->vverbose_v2(daemon.closure, level, file, line, func, fmt, args); + va_end(args); +} + +/** + * @deprecated use bindings version 3 + * * Get the root directory file descriptor. This file descriptor can * be used with functions 'openat', 'fstatat', ... + * + * Returns the file descriptor or -1 in case of error. */ -static inline int afb_daemon_rootdir_get_fd_v1(struct afb_daemon daemon) +static inline int afb_daemon_rootdir_get_fd_v1(struct afb_daemon_x1 daemon) { return daemon.itf->rootdir_get_fd(daemon.closure); } -/* - * Opens 'filename' within the root directory with 'flags' (see function openat) +/** + * @deprecated use bindings version 3 + * * using the 'locale' definition (example: "jp,en-US") that can be NULL. + * * Returns the file descriptor or -1 in case of error. */ -static inline int afb_daemon_rootdir_open_locale_v1(struct afb_daemon daemon, const char *filename, int flags, const char *locale) +static inline int afb_daemon_rootdir_open_locale_v1(struct afb_daemon_x1 daemon, const char *filename, int flags, const char *locale) { return daemon.itf->rootdir_open_locale(daemon.closure, filename, flags, locale); } -/* +/** + * @deprecated use bindings version 3 + * * Queue the job defined by 'callback' and 'argument' for being executed asynchronously * in this thread (later) or in an other thread. * If 'group' is not NUL, the jobs queued with a same value (as the pointer value 'group') @@ -118,7 +190,54 @@ static inline int afb_daemon_rootdir_open_locale_v1(struct afb_daemon daemon, co * * Returns 0 in case of success or -1 in case of error. */ -static inline int afb_daemon_queue_job_v1(struct afb_daemon daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout) +static inline int afb_daemon_queue_job_v1(struct afb_daemon_x1 daemon, void (*callback)(int signum, void *arg), void *argument, void *group, int timeout) { return daemon.itf->queue_job(daemon.closure, callback, argument, group, timeout); } + +/** + * @deprecated use bindings version 3 + * + * Tells that it requires the API of "name" to exist + * and if 'initialized' is not null to be initialized. + * Calling this function is only allowed within init. + * + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_daemon_require_api_v1(struct afb_daemon_x1 daemon, const char *name, int initialized) +{ + return daemon.itf->require_api(daemon.closure, name, initialized); +} + +/** + * @deprecated use bindings version 3 + * + * Create an aliased name 'as_name' for the api 'name'. + * Calling this function is only allowed within preinit. + * + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_daemon_add_alias_v1(struct afb_daemon_x1 daemon, const char *name, const char *as_name) +{ + return daemon.itf->add_alias(daemon.closure, name, as_name); +} + +/** + * @deprecated use bindings version 3 + * + * Creates a new api of name 'api' with brief 'info'. + * + * Returns 0 in case of success or -1 in case of error. + */ +static inline int afb_daemon_new_api_v1( + struct afb_daemon_x1 daemon, + const char *api, + const char *info, + int noconcurrency, + int (*preinit)(void*, struct afb_api_x3 *), + void *closure) +{ + return -!daemon.itf->new_api(daemon.closure, api, info, noconcurrency, preinit, closure); +} + +/** @} */