X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-req-common.h;h=1bb017efcd7ff13fcabaddd149f905a0142ccca3;hb=5659246230cef16abae4b1edda9791a1f25fc03d;hp=9fce668febc94248dc99f3b3d565dd66fd4f6a7b;hpb=052c3aee6362b2e33c060e0fbddd68439bb73dcb;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-req-common.h b/include/afb/afb-req-common.h index 9fce668f..1bb017ef 100644 --- a/include/afb/afb-req-common.h +++ b/include/afb/afb-req-common.h @@ -23,6 +23,7 @@ struct json_object; struct afb_stored_req; +struct afb_req; /* * Describes an argument (or parameter) of a request @@ -72,6 +73,10 @@ struct afb_req_itf void (*vverbose)(void *closure, int level, const char *file, int line, const char * func, const char *fmt, va_list args); struct afb_stored_req *(*store)(void *closure); + void (*subcall_req)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*, struct afb_req), void *cb_closure); + + int (*has_permission)(void *closure, const char *permission); + char *(*get_application_id)(void *closure); }; /* @@ -84,7 +89,7 @@ struct afb_req }; /* - * Checks wether the request 'req' is valid or not. + * Checks whether the request 'req' is valid or not. * * Returns 0 if not valid or 1 if valid. */ @@ -343,12 +348,39 @@ static inline int afb_req_unsubscribe(struct afb_req req, struct afb_event event * For convenience, the function calls 'json_object_put' for 'args'. * Thus, in the case where 'args' should remain available after * the function returns, the function 'json_object_get' shall be used. + * + * See also: + * - 'afb_req_subcall_req' that is convenient to keep request alive automatically. + * - 'afb_req_subcall_sync' the synchronous version */ static inline void afb_req_subcall(struct afb_req req, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result), void *closure) { 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'. + * On completion, the function 'callback' is invoked with the + * original request 'req', the 'closure' given at call and two + * other parameters: 'iserror' and 'result'. + * 'status' is 0 on success or negative when on an error reply. + * 'result' is the json object of the reply, you must not call json_object_put + * on the result. + * + * For convenience, the function calls 'json_object_put' for 'args'. + * Thus, in the case where 'args' should remain available after + * the function returns, the function 'json_object_get' shall be used. + * + * See also: + * - 'afb_req_subcall' that doesn't keep request alive automatically. + * - 'afb_req_subcall_sync' the synchronous version + */ +static inline void afb_req_subcall_req(struct afb_req req, const char *api, const char *verb, struct json_object *args, void (*callback)(void *closure, int iserror, struct json_object *result, struct afb_req req), void *closure) +{ + req.itf->subcall_req(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'. @@ -360,6 +392,10 @@ static inline void afb_req_subcall(struct afb_req req, const char *api, const ch * For convenience, the function calls 'json_object_put' for 'args'. * Thus, in the case where 'args' should remain available after * the function returns, the function 'json_object_get' shall be used. + * + * See also: + * - 'afb_req_subcall_req' that is convenient to keep request alive automatically. + * - 'afb_req_subcall' that doesn't keep request alive automatically. */ 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) { @@ -398,3 +434,29 @@ static inline void afb_req_verbose(struct afb_req req, int level, const char *fi #else #define AFB_REQ_VERBOSE(req,level,...) afb_req_verbose(req,level,NULL,0,NULL,__VA_ARGS__) #endif + +/* + * Check whether the 'permission' is granted or not to the client + * identified by 'req'. + * + * Returns 1 if the permission is granted or 0 otherwise. + */ +static inline int afb_req_has_permission(struct afb_req req, const char *permission) +{ + return req.itf->has_permission(req.closure, permission); +} + +/* + * Get the application identifier of the client application for the + * request 'req'. + * + * Returns the application identifier or NULL when the application + * can not be identified. + * + * The returned value if not NULL must be freed by the caller + */ +static inline char *afb_req_get_application_id(struct afb_req req) +{ + return req.itf->get_application_id(req.closure); +} +