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-request-itf.h"
22 #include "afb-event.h"
25 * Describes the request by bindings from afb-daemon
29 const struct afb_request_itf *itf; /* the interface to use */
30 struct afb_request *closure; /* the closure argument for functions of 'itf' */
34 * Checks whether the request 'req' is valid or not.
36 * Returns 0 if not valid or 1 if valid.
38 static inline int afb_req_is_valid(struct afb_req req)
44 * Gets from the request 'req' the argument of 'name'.
45 * Returns a PLAIN structure of type 'struct afb_arg'.
46 * When the argument of 'name' is not found, all fields of result are set to NULL.
47 * When the argument of 'name' is found, the fields are filled,
48 * in particular, the field 'result.name' is set to 'name'.
50 * There is a special name value: the empty string.
51 * The argument of name "" is defined only if the request was made using
52 * an HTTP POST of Content-Type "application/json". In that case, the
53 * argument of name "" receives the value of the body of the HTTP request.
55 static inline struct afb_arg afb_req_get(struct afb_req req, const char *name)
57 return req.itf->get(req.closure, name);
61 * Gets from the request 'req' the string value of the argument of 'name'.
62 * Returns NULL if when there is no argument of 'name'.
63 * Returns the value of the argument of 'name' otherwise.
65 * Shortcut for: afb_req_get(req, name).value
67 static inline const char *afb_req_value(struct afb_req req, const char *name)
69 return afb_req_get(req, name).value;
73 * Gets from the request 'req' the path for file attached to the argument of 'name'.
74 * Returns NULL if when there is no argument of 'name' or when there is no file.
75 * Returns the path of the argument of 'name' otherwise.
77 * Shortcut for: afb_req_get(req, name).path
79 static inline const char *afb_req_path(struct afb_req req, const char *name)
81 return afb_req_get(req, name).path;
85 * Gets from the request 'req' the json object hashing the arguments.
86 * The returned object must not be released using 'json_object_put'.
88 static inline struct json_object *afb_req_json(struct afb_req req)
90 return req.itf->json(req.closure);
94 * Sends a reply of kind success to the request 'req'.
95 * The status of the reply is automatically set to "success".
96 * Its send the object 'obj' (can be NULL) with an
97 * informationnal comment 'info (can also be NULL).
99 * For convenience, the function calls 'json_object_put' for 'obj'.
100 * Thus, in the case where 'obj' should remain available after
101 * the function returns, the function 'json_object_get' shall be used.
103 static inline void afb_req_success(struct afb_req req, struct json_object *obj, const char *info)
105 req.itf->success(req.closure, obj, info);
109 * Same as 'afb_req_success' but the 'info' is a formatting
110 * string followed by arguments.
112 * For convenience, the function calls 'json_object_put' for 'obj'.
113 * Thus, in the case where 'obj' should remain available after
114 * the function returns, the function 'json_object_get' shall be used.
116 static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...) __attribute__((format(printf, 3, 4)));
117 static inline void afb_req_success_f(struct afb_req req, struct json_object *obj, const char *info, ...)
120 va_start(args, info);
121 req.itf->vsuccess(req.closure, obj, info, args);
126 * Same as 'afb_req_success_f' but the arguments to the format 'info'
127 * are given as a variable argument list instance.
129 * For convenience, the function calls 'json_object_put' for 'obj'.
130 * Thus, in the case where 'obj' should remain available after
131 * the function returns, the function 'json_object_get' shall be used.
133 static inline void afb_req_success_v(struct afb_req req, struct json_object *obj, const char *info, va_list args)
135 req.itf->vsuccess(req.closure, obj, info, args);
139 * Sends a reply of kind failure to the request 'req'.
140 * The status of the reply is set to 'status' and an
141 * informationnal comment 'info' (can also be NULL) can be added.
143 * Note that calling afb_req_fail("success", info) is equivalent
144 * to call afb_req_success(NULL, info). Thus even if possible it
145 * is strongly recommanded to NEVER use "success" for status.
147 static inline void afb_req_fail(struct afb_req req, const char *status, const char *info)
149 req.itf->fail(req.closure, status, info);
153 * Same as 'afb_req_fail' but the 'info' is a formatting
154 * string followed by arguments.
156 static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...) __attribute__((format(printf, 3, 4)));
157 static inline void afb_req_fail_f(struct afb_req req, const char *status, const char *info, ...)
160 va_start(args, info);
161 req.itf->vfail(req.closure, status, info, args);
166 * Same as 'afb_req_fail_f' but the arguments to the format 'info'
167 * are given as a variable argument list instance.
169 static inline void afb_req_fail_v(struct afb_req req, const char *status, const char *info, va_list args)
171 req.itf->vfail(req.closure, status, info, args);
175 * Gets the pointer stored by the binding for the session of 'req'.
176 * When the binding has not yet recorded a pointer, NULL is returned.
178 static inline void *afb_req_context_get(struct afb_req req)
180 return req.itf->context_get(req.closure);
184 * Stores for the binding the pointer 'context' to the session of 'req'.
185 * The function 'free_context' will be called when the session is closed
186 * or if binding stores an other pointer.
188 static inline void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*))
190 req.itf->context_set(req.closure, context, free_context);
194 * Gets the pointer stored by the binding for the session of 'req'.
195 * If the stored pointer is NULL, indicating that no pointer was
196 * already stored, afb_req_context creates a new context by calling
197 * the function 'create_context' and stores it with the freeing function
200 static inline void *afb_req_context(struct afb_req req, void *(*create_context)(), void (*free_context)(void*))
202 return req.itf->context_make(req.closure, 0, (void *(*)(void*))(void*)create_context, free_context, 0);
206 * Gets the pointer stored by the binding for the session of 'request'.
207 * If no previous pointer is stored or if 'replace' is not zero, a new value
208 * is generated using the function 'create_context' called with the 'closure'.
209 * If 'create_context' is NULL the generated value is 'closure'.
210 * When a value is created, the function 'free_context' is recorded and will
211 * be called (with the created value as argument) to free the created value when
212 * it is not more used.
213 * This function is atomic: it ensures that 2 threads will not race together.
215 static inline void *afb_req_context_make(struct afb_req req, int replace, void *(*create_context)(void *closure), void (*free_context)(void*), void *closure)
217 return req.itf->context_make(req.closure, replace, create_context, free_context, closure);
221 * Frees the pointer stored by the binding for the session of 'req'
222 * and sets it to NULL.
224 * Shortcut for: afb_req_context_set(req, NULL, NULL)
226 static inline void afb_req_context_clear(struct afb_req req)
228 afb_req_context_set(req, 0, 0);
232 * Adds one to the count of references of 'req'.
233 * This function MUST be called by asynchronous implementations
234 * of verbs if no reply was sent before returning.
236 static inline void afb_req_addref(struct afb_req req)
238 req.itf->addref(req.closure);
242 * Substracts one to the count of references of 'req'.
243 * This function MUST be called by asynchronous implementations
244 * of verbs after sending the asynchronous reply.
246 static inline void afb_req_unref(struct afb_req req)
248 req.itf->unref(req.closure);
252 * Closes the session associated with 'req'
253 * and delete all associated contexts.
255 static inline void afb_req_session_close(struct afb_req req)
257 req.itf->session_close(req.closure);
261 * Sets the level of assurance of the session of 'req'
262 * to 'level'. The effect of this function is subject of
264 * Returns 1 on success or 0 if failed.
266 static inline int afb_req_session_set_LOA(struct afb_req req, unsigned level)
268 return req.itf->session_set_LOA(req.closure, level);
272 * Establishes for the client link identified by 'req' a subscription
274 * Returns 0 in case of successful subscription or -1 in case of error.
276 static inline int afb_req_subscribe(struct afb_req req, struct afb_event event)
278 return req.itf->subscribe(req.closure, event);
282 * Revokes the subscription established to the 'event' for the client
283 * link identified by 'req'.
284 * Returns 0 in case of successful subscription or -1 in case of error.
286 static inline int afb_req_unsubscribe(struct afb_req req, struct afb_event event)
288 return req.itf->unsubscribe(req.closure, event);
292 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
293 * This call is made in the context of the request 'req'.
294 * On completion, the function 'callback' is invoked with the
295 * 'closure' given at call and two other parameters: 'iserror' and 'result'.
296 * 'status' is 0 on success or negative when on an error reply.
297 * 'result' is the json object of the reply, you must not call json_object_put
300 * For convenience, the function calls 'json_object_put' for 'args'.
301 * Thus, in the case where 'args' should remain available after
302 * the function returns, the function 'json_object_get' shall be used.
305 * - 'afb_req_subcall_req' that is convenient to keep request alive automatically.
306 * - 'afb_req_subcall_sync' the synchronous version
308 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)
310 req.itf->subcall(req.closure, api, verb, args, callback, closure);
314 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
315 * This call is made in the context of the request 'req'.
316 * On completion, the function 'callback' is invoked with the
317 * original request 'req', the 'closure' given at call and two
318 * other parameters: 'iserror' and 'result'.
319 * 'status' is 0 on success or negative when on an error reply.
320 * 'result' is the json object of the reply, you must not call json_object_put
323 * For convenience, the function calls 'json_object_put' for 'args'.
324 * Thus, in the case where 'args' should remain available after
325 * the function returns, the function 'json_object_get' shall be used.
328 * - 'afb_req_subcall' that doesn't keep request alive automatically.
329 * - 'afb_req_subcall_sync' the synchronous version
331 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)
333 req.itf->subcall_req(req.closure, api, verb, args, callback, closure);
337 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
338 * This call is made in the context of the request 'req'.
339 * This call is synchronous, it waits untill completion of the request.
340 * It returns 0 on success or a negative value on error answer.
341 * The object pointed by 'result' is filled and must be released by the caller
342 * after its use by calling 'json_object_put'.
344 * For convenience, the function calls 'json_object_put' for 'args'.
345 * Thus, in the case where 'args' should remain available after
346 * the function returns, the function 'json_object_get' shall be used.
349 * - 'afb_req_subcall_req' that is convenient to keep request alive automatically.
350 * - 'afb_req_subcall' that doesn't keep request alive automatically.
352 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)
354 return req.itf->subcallsync(req.closure, api, verb, args, result);
358 * Send associated to 'req' a message described by 'fmt' and following parameters
359 * to the journal for the verbosity 'level'.
361 * 'file', 'line' and 'func' are indicators of position of the code in source files
362 * (see macros __FILE__, __LINE__ and __func__).
364 * 'level' is defined by syslog standard:
365 * EMERGENCY 0 System is unusable
366 * ALERT 1 Action must be taken immediately
367 * CRITICAL 2 Critical conditions
368 * ERROR 3 Error conditions
369 * WARNING 4 Warning conditions
370 * NOTICE 5 Normal but significant condition
371 * INFO 6 Informational
372 * DEBUG 7 Debug-level messages
374 static inline void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...) __attribute__((format(printf, 6, 7)));
375 static inline void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...)
379 req.itf->vverbose(req.closure, level, file, line, func, fmt, args);
383 /* macro for setting file, line and function automatically */
384 # if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
385 #define AFB_REQ_VERBOSE(req,level,...) afb_req_verbose(req,level,__FILE__,__LINE__,__func__,__VA_ARGS__)
387 #define AFB_REQ_VERBOSE(req,level,...) afb_req_verbose(req,level,NULL,0,NULL,__VA_ARGS__)
391 * Check whether the 'permission' is granted or not to the client
392 * identified by 'req'.
394 * Returns 1 if the permission is granted or 0 otherwise.
396 static inline int afb_req_has_permission(struct afb_req req, const char *permission)
398 return req.itf->has_permission(req.closure, permission);
402 * Get the application identifier of the client application for the
405 * Returns the application identifier or NULL when the application
406 * can not be identified.
408 * The returned value if not NULL must be freed by the caller
410 static inline char *afb_req_get_application_id(struct afb_req req)
412 return req.itf->get_application_id(req.closure);