X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-req-itf.h;h=8f8dc8a95dc7fefe941c5fd8bfc93504325a1b18;hb=3ffd607b9321c9a7f1c483d4a5e5e4f9e5abbc03;hp=af452faf0fb0d03ccd7d1eefa1fc5b1c46a5e021;hpb=7059e59cddc1c81321639875636e88895bc14309;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h index af452faf..8f8dc8a9 100644 --- a/include/afb/afb-req-itf.h +++ b/include/afb/afb-req-itf.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2016 "IoT.bzh" + * Copyright (C) 2016, 2017 "IoT.bzh" * Author: José Bollo * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -25,7 +25,7 @@ #include #include -#include +#include "afb-event-itf.h" /* avoid inclusion of */ struct json_object; @@ -46,7 +46,7 @@ struct afb_arg { * It records the functions to be called for the request. * Don't use this structure directly. * Use the helper functions documented below. - */ + */ struct afb_req_itf { /* CAUTION: respect the order, add at the end */ @@ -72,6 +72,7 @@ struct afb_req_itf { int (*unsubscribe)(void *closure, struct afb_event event); void (*subcall)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *cb_closure); + int (*subcallsync)(void *closure, const char *api, const char *verb, struct json_object *args, struct json_object **result); }; /* @@ -82,6 +83,16 @@ struct afb_req { void *closure; /* the closure argument for functions of 'itf' */ }; +/* + * Checks wether the request 'req' is valid or not. + * + * Returns 0 if not valid or 1 if valid. + */ +static inline int afb_req_is_valid(struct afb_req req) +{ + return req.itf != NULL; +} + /* * Gets from the request 'req' the argument of 'name'. * Returns a PLAIN structure of type 'struct afb_arg'. @@ -138,7 +149,7 @@ static inline struct json_object *afb_req_json(struct afb_req req) * Its send the object 'obj' (can be NULL) with an * informationnal comment 'info (can also be NULL). * - * For conveniency, the function calls 'json_object_put' for 'obj'. + * For convenience, the function calls 'json_object_put' for 'obj'. * Thus, in the case where 'obj' should remain available after * the function returns, the function 'json_object_get' shall be used. */ @@ -151,7 +162,7 @@ static inline void afb_req_success(struct afb_req req, struct json_object *obj, * Same as 'afb_req_success' but the 'info' is a formatting * string followed by arguments. * - * For conveniency, the function calls 'json_object_put' for 'obj'. + * For convenience, the function calls 'json_object_put' for 'obj'. * Thus, in the case where 'obj' should remain available after * the function returns, the function 'json_object_get' shall be used. */ @@ -176,7 +187,7 @@ static inline void afb_req_success_f(struct afb_req req, struct json_object *obj * to call afb_req_success(NULL, info). Thus even if possible it * is strongly recommanded to NEVER use "success" for status. * - * For conveniency, the function calls 'json_object_put' for 'obj'. + * For convenience, the function calls 'json_object_put' for 'obj'. * Thus, in the case where 'obj' should remain available after * the function returns, the function 'json_object_get' shall be used. */ @@ -189,7 +200,7 @@ static inline void afb_req_fail(struct afb_req req, const char *status, const ch * Same as 'afb_req_fail' but the 'info' is a formatting * string followed by arguments. * - * For conveniency, the function calls 'json_object_put' for 'obj'. + * For convenience, the function calls 'json_object_put' for 'obj'. * Thus, in the case where 'obj' should remain available after * the function returns, the function 'json_object_get' shall be used. */ @@ -300,7 +311,7 @@ static inline int afb_req_session_set_LOA(struct afb_req req, unsigned level) */ static inline struct afb_req *afb_req_store(struct afb_req req) { - struct afb_req *result = malloc(sizeof *result); + struct afb_req *result = (struct afb_req*)malloc(sizeof *result); if (result != NULL) { *result = req; afb_req_addref(req); @@ -355,6 +366,19 @@ static inline void afb_req_subcall(struct afb_req req, const char *api, const ch req.itf->subcall(req.closure, api, verb, args, callback, closure); } +/* + * Makes a call to the method of name 'api' / 'verb' with the object 'args'. + * This call is made in the context of the request 'req'. + * This call is synchronous, it waits untill completion of the request. + * It returns 0 on an error answer and returns 1 when no error was detected. + * The object pointed by 'result' is filled and must be released by the caller + * after its use by calling 'json_object_put'. + */ +static inline int afb_req_subcall_sync(struct afb_req req, const char *api, const char *verb, struct json_object *args, struct json_object **result) +{ + return req.itf->subcallsync(req.closure, api, verb, args, result); +} + /* internal use */ static inline const char *afb_req_raw(struct afb_req req, size_t *size) {