X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-daemon-v2.h;h=098e36c64b5a22613b59bacc074ab749806ccdaf;hb=65353dce81a629e042800bb7b86fcd869a76727e;hp=4c4c656d33ab4e5acbf4f3ed8d770866d1de08ce;hpb=c6380108964e71f533d8c672bb9c217020a95e8d;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-daemon-v2.h b/include/afb/afb-daemon-v2.h index 4c4c656d..098e36c6 100644 --- a/include/afb/afb-daemon-v2.h +++ b/include/afb/afb-daemon-v2.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,9 +17,14 @@ #pragma once -#include "afb-daemon-common.h" +#include "afb-daemon-itf-x1.h" -/* +/** @addtogroup AFB_DAEMON + * @{ */ + +/** + * @deprecated use bindings version 3 + * * Retrieves the common systemd's event loop of AFB */ static inline struct sd_event *afb_daemon_get_event_loop_v2() @@ -27,7 +32,9 @@ static inline struct sd_event *afb_daemon_get_event_loop_v2() return afb_get_daemon_v2().itf->get_event_loop(afb_get_daemon_v2().closure); } -/* +/** + * @deprecated use bindings version 3 + * * Retrieves the common systemd's user/session d-bus of AFB */ static inline struct sd_bus *afb_daemon_get_user_bus_v2() @@ -35,7 +42,9 @@ static inline struct sd_bus *afb_daemon_get_user_bus_v2() return afb_get_daemon_v2().itf->get_user_bus(afb_get_daemon_v2().closure); } -/* +/** + * @deprecated use bindings version 3 + * * Retrieves the common systemd's system d-bus of AFB */ static inline struct sd_bus *afb_daemon_get_system_bus_v2() @@ -43,7 +52,9 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v2() return afb_get_daemon_v2().itf->get_system_bus(afb_get_daemon_v2().closure); } -/* +/** + * @deprecated use bindings version 3 + * * Broadcasts widely the event of 'name' with the data 'object'. * 'object' can be NULL. * @@ -51,22 +62,32 @@ static inline struct sd_bus *afb_daemon_get_system_bus_v2() * 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_v2(const char *name, struct json_object *object) { return afb_get_daemon_v2().itf->event_broadcast(afb_get_daemon_v2().closure, name, object); } -/* +/** + * @deprecated use bindings version 3 + * * Creates an event of 'name' and returns it. + * + * 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_v2(const char *name) +static inline struct afb_event_x1 afb_daemon_make_event_v2(const char *name) { return afb_get_daemon_v2().itf->event_make(afb_get_daemon_v2().closure, name); } -/* +/** + * @deprecated use bindings version 3 + * * Send a message described by 'fmt' and following parameters * to the journal for the verbosity 'level'. * @@ -92,18 +113,25 @@ static inline void afb_daemon_verbose_v2(int level, const char *file, int line, 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_v2() { return afb_get_daemon_v2().itf->rootdir_get_fd(afb_get_daemon_v2().closure); } -/* +/** + * @deprecated use bindings version 3 + * * Opens 'filename' within the root directory with 'flags' (see function openat) * 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_v2(const char *filename, int flags, const char *locale) @@ -111,7 +139,9 @@ static inline int afb_daemon_rootdir_open_locale_v2(const char *filename, int fl return afb_get_daemon_v2().itf->rootdir_open_locale(afb_get_daemon_v2().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') @@ -129,15 +159,63 @@ static inline int afb_daemon_queue_job_v2(void (*callback)(int signum, void *arg return afb_get_daemon_v2().itf->queue_job(afb_get_daemon_v2().closure, callback, argument, group, timeout); } -/* +/** + * @deprecated use bindings version 3 + * * Retrieves the afb_req stored at 'sreq'. * Returns the stored request. * The count of reference is UNCHANGED, thus, the * function 'afb_req_unref' should be called on the result * after that the asynchronous reply if sent. */ -static inline struct afb_req afb_daemon_unstore_req_v2(struct afb_stored_req *sreq) +static inline struct afb_req_x1 afb_daemon_unstore_req_v2(struct afb_stored_req *sreq) { return afb_get_daemon_v2().itf->unstore_req(afb_get_daemon_v2().closure, sreq); } +/** + * @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_v2(const char *name, int initialized) +{ + return afb_get_daemon_v2().itf->require_api(afb_get_daemon_v2().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_v2(const char *name, const char *as_name) +{ + return afb_get_daemon_v2().itf->add_alias(afb_get_daemon_v2().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_v2( + const char *api, + const char *info, + int noconcurrency, + int (*preinit)(void*, struct afb_api_x3 *), + void *closure) +{ + return -!(afb_get_daemon_v2().itf->new_api(afb_get_daemon_v2().closure, api, info, noconcurrency, preinit, closure)); +} + +/** @} */ +