1 Functions of class **afb_req**
2 ============================
10 * Checks whether the request 'req' is valid or not.
12 * @param req the request to check
14 * @return 0 if not valid or 1 if valid.
24 * Retrieves the api that serves the request
26 * @param req the request whose serving api is queried
28 * @return the api serving the request
30 afb_api_t afb_req_get_api(
34 ### afb_req_get_vcbdata
38 * Retrieves the callback data of the verb. This callback data is set
39 * when the verb is created.
41 * @param req whose verb vcbdata is queried
43 * @return the callback data attached to the verb description
45 void *afb_req_get_vcbdata(
49 ### afb_req_get_called_api
53 * Retrieve the name of the called api.
55 * @param req the request
57 * @return the name of the called api
59 * @see afb_api_new_api
60 * @see afb_api_add_alias
62 const char *afb_req_get_called_api(
66 ### afb_req_get_called_verb
70 * Retrieve the name of the called verb
72 * @param req the request
74 * @return the name of the called verb
76 const char *afb_req_get_called_verb(
84 * Increments the count of references of 'req'.
86 * @param req the request
88 * @return returns the request req
90 afb_req_t *afb_req_addref(
98 * Decrement the count of references of 'req'.
100 * @param req the request
109 ### afb_req_wants_log_level
113 * Is the log message of 'level (as defined for syslog) required for the
116 * @param req the request
117 * @param level the level to check as defined for syslog:
119 * EMERGENCY 0 System is unusable
120 * ALERT 1 Action must be taken immediately
121 * CRITICAL 2 Critical conditions
122 * ERROR 3 Error conditions
123 * WARNING 4 Warning conditions
124 * NOTICE 5 Normal but significant condition
125 * INFO 6 Informational
126 * DEBUG 7 Debug-level messages
128 * @return 0 if not required or a value not null if required
132 int afb_req_wants_log_level(
141 * Send associated to 'req' a message described by 'fmt' and its 'args'
142 * to the journal for the verbosity 'level'.
144 * 'file', 'line' and 'func' are indicators of position of the code in source files
145 * (see macros __FILE__, __LINE__ and __func__).
147 * 'level' is defined by syslog standard:
148 * EMERGENCY 0 System is unusable
149 * ALERT 1 Action must be taken immediately
150 * CRITICAL 2 Critical conditions
151 * ERROR 3 Error conditions
152 * WARNING 4 Warning conditions
153 * NOTICE 5 Normal but significant condition
154 * INFO 6 Informational
155 * DEBUG 7 Debug-level messages
157 * @param req the request
158 * @param level the level of the message
159 * @param file the source filename that emits the message or NULL
160 * @param line the line number in the source filename that emits the message
161 * @param func the name of the function that emits the message or NULL
162 * @param fmt the message format as for printf
163 * @param args the arguments to the format
166 * @see afb_req_verbose
168 void afb_req_vverbose(
170 int level, const char *file,
181 * Send associated to 'req' a message described by 'fmt' and following parameters
182 * to the journal for the verbosity 'level'.
184 * 'file', 'line' and 'func' are indicators of position of the code in source files
185 * (see macros __FILE__, __LINE__ and __func__).
187 * 'level' is defined by syslog standard:
188 * EMERGENCY 0 System is unusable
189 * ALERT 1 Action must be taken immediately
190 * CRITICAL 2 Critical conditions
191 * ERROR 3 Error conditions
192 * WARNING 4 Warning conditions
193 * NOTICE 5 Normal but significant condition
194 * INFO 6 Informational
195 * DEBUG 7 Debug-level messages
197 * @param req the request
198 * @param level the level of the message
199 * @param file the source filename that emits the message or NULL
200 * @param line the line number in the source filename that emits the message
201 * @param func the name of the function that emits the message or NULL
202 * @param fmt the message format as for printf
203 * @param ... the arguments of the format 'fmt'
207 void afb_req_verbose(
209 int level, const char *file,
216 ## Arguments/parameters function
222 * Gets from the request 'req' the argument of 'name'.
224 * Returns a PLAIN structure of type 'struct afb_arg'.
226 * When the argument of 'name' is not found, all fields of result are set to NULL.
228 * When the argument of 'name' is found, the fields are filled,
229 * in particular, the field 'result.name' is set to 'name'.
231 * There is a special name value: the empty string.
232 * The argument of name "" is defined only if the request was made using
233 * an HTTP POST of Content-Type "application/json". In that case, the
234 * argument of name "" receives the value of the body of the HTTP request.
236 * @param req the request
237 * @param name the name of the argument to get
239 * @return a structure describing the retrieved argument for the request
244 struct afb_arg afb_req_get(
253 * Gets from the request 'req' the string value of the argument of 'name'.
254 * Returns NULL if when there is no argument of 'name'.
255 * Returns the value of the argument of 'name' otherwise.
257 * Shortcut for: afb_req_get(req, name).value
259 * @param req the request
260 * @param name the name of the argument's value to get
262 * @return the value as a string or NULL
267 const char *afb_req_value(
276 * Gets from the request 'req' the path for file attached to the argument of 'name'.
277 * Returns NULL if when there is no argument of 'name' or when there is no file.
278 * Returns the path of the argument of 'name' otherwise.
280 * Shortcut for: afb_req_get(req, name).path
282 * @param req the request
283 * @param name the name of the argument's path to get
285 * @return the path if any or NULL
290 const char *afb_req_path(
299 * Gets from the request 'req' the json object hashing the arguments.
301 * The returned object must not be released using 'json_object_put'.
303 * @param req the request
305 * @return the JSON object of the query
311 struct json_object *afb_req_json(
317 The functions **success** and **fail** are still supported.
318 These functions are now implemented as the following macros:
321 #define afb_req_success(r,o,i) afb_req_reply(r,o,NULL,i)
322 #define afb_req_success_f(r,o,...) afb_req_reply_f(r,o,NULL,__VA_ARGS__)
323 #define afb_req_success_v(r,o,f,v) afb_req_reply_v(r,o,NULL,f,v)
324 #define afb_req_fail(r,e,i) afb_req_reply(r,NULL,e,i)
325 #define afb_req_fail_f(r,e,...) afb_req_reply_f(r,NULL,e,__VA_ARGS__)
326 #define afb_req_fail_v(r,e,f,v) afb_req_reply_v(r,NULL,e,f,v)
334 * Sends a reply to the request 'req'.
336 * The status of the reply is set to 'error' (that must be NULL on success).
337 * Its send the object 'obj' (can be NULL) with an
338 * informational comment 'info (can also be NULL).
340 * For convenience, the function calls 'json_object_put' for 'obj'.
341 * Thus, in the case where 'obj' should remain available after
342 * the function returns, the function 'json_object_get' shall be used.
344 * @param req the request
345 * @param obj the replied object or NULL
346 * @param error the error message if it is a reply error or NULL
347 * @param info an informative text or NULL
349 * @see afb_req_reply_v
350 * @see afb_req_reply_f
354 struct json_object *obj,
363 * Same as 'afb_req_reply_f' but the arguments to the format 'info'
364 * are given as a variable argument list instance.
366 * For convenience, the function calls 'json_object_put' for 'obj'.
367 * Thus, in the case where 'obj' should remain available after
368 * the function returns, the function 'json_object_get' shall be used.
370 * @param req the request
371 * @param obj the replied object or NULL
372 * @param error the error message if it is a reply error or NULL
373 * @param info an informative text containing a format as for vprintf
374 * @param args the va_list of arguments to the format as for vprintf
377 * @see afb_req_reply_f
380 void afb_req_reply_v(
382 struct json_object *obj,
392 * Same as 'afb_req_reply' but the 'info' is a formatting
393 * string followed by arguments.
395 * For convenience, the function calls 'json_object_put' for 'obj'.
396 * Thus, in the case where 'obj' should remain available after
397 * the function returns, the function 'json_object_get' shall be used.
399 * @param req the request
400 * @param obj the replied object or NULL
401 * @param error the error message if it is a reply error or NULL
402 * @param info an informative text containing a format as for printf
403 * @param ... the arguments to the format as for printf
406 * @see afb_req_reply_v
409 void afb_req_reply_f(
411 struct json_object *obj,
425 * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
426 * The result of the call is delivered to the 'callback' function with the 'callback_closure'.
428 * For convenience, the function calls 'json_object_put' for 'args'.
429 * Thus, in the case where 'args' should remain available after
430 * the function returns, the function 'json_object_get' shall be used.
432 * The 'callback' receives 5 arguments:
433 * 1. 'closure' the user defined closure pointer 'closure',
434 * 2. 'object' a JSON object returned (can be NULL)
435 * 3. 'error' a string not NULL in case of error
436 * 4. 'info' a string handling some info (can be NULL)
439 * NOTE: For convenience, *json_object_put* is called on 'object' after the
440 * callback returns. So, it is wrong to call *json_object_put* in the callback.
442 * @param req The request
443 * @param api The api name of the method to call
444 * @param verb The verb name of the method to call
445 * @param args The arguments to pass to the method
446 * @param flags The bit field of flags for the subcall as defined by @ref afb_req_subcall_flags_t
447 * @param callback The to call on completion
448 * @param closure The closure to pass to the callback
450 * The flags are any combination of the following values:
452 * - afb_req_x2_subcall_catch_events = 1
454 * the calling API wants to receive the events from subscription
456 * - afb_req_x2_subcall_pass_events = 2
458 * the original request will receive the events from subscription
460 * - afb_req_x2_subcall_on_behalf = 4
462 * the calling API wants to use the credentials of the original request
464 * - afb_req_x2_subcall_api_session = 8
466 * the calling API wants to use its session instead of the one of the
469 * @see also 'afb_req_subcall_sync'
471 void afb_req_subcall(
475 struct json_object *args,
479 struct json_object *object,
486 ### afb_req_subcall_sync
490 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
491 * This call is made in the context of the request 'req'.
492 * This call is synchronous, it waits untill completion of the request.
493 * It returns 0 on success or a negative value on error answer.
495 * For convenience, the function calls 'json_object_put' for 'args'.
496 * Thus, in the case where 'args' should remain available after
497 * the function returns, the function 'json_object_get' shall be used.
500 * - 'afb_req_subcall_req' that is convenient to keep request alive automatically.
501 * - 'afb_req_subcall' that doesn't keep request alive automatically.
503 * @param req The request
504 * @param api The api name of the method to call
505 * @param verb The verb name of the method to call
506 * @param args The arguments to pass to the method
507 * @param flags The bit field of flags for the subcall as defined by @ref afb_req_subcall_flags
508 * @param object a pointer where the replied JSON object is stored must be freed using @ref json_object_put (can be NULL)
509 * @param error a pointer where a copy of the replied error is stored must be freed using @ref free (can be NULL)
510 * @param info a pointer where a copy of the replied info is stored must be freed using @ref free (can be NULL)
512 * @return 0 in case of success or -1 in case of error
514 int afb_req_subcall_sync(
518 struct json_object *args,
520 struct json_object **object,
527 ### afb_req_subscribe
531 * Establishes for the client link identified by 'req' a subscription
534 * Establishing subscription MUST be called BEFORE replying to the request.
536 * @param req the request
537 * @param event the event to subscribe
539 * @return 0 in case of successful subscription or -1 in case of error.
541 int afb_req_subscribe(
546 ### afb_req_unsubscribe
550 * Revokes the subscription established to the 'event' for the client
551 * link identified by 'req'.
552 * Returns 0 in case of successful subscription or -1 in case of error.
554 * Revoking subscription MUST be called BEFORE replying to the request.
556 * @param req the request
557 * @param event the event to revoke
559 * @return 0 in case of successful subscription or -1 in case of error.
561 int afb_req_unsubscribe(
572 * Manage the pointer stored by the binding for the client session of 'req'.
574 * If no previous pointer is stored or if 'replace' is not zero, a new value
575 * is generated using the function 'create_context' called with the 'closure'.
576 * If 'create_context' is NULL the generated value is 'closure'.
578 * When a value is created, the function 'free_context' is recorded and will
579 * be called (with the created value as argument) to free the created value when
580 * it is not more used.
582 * This function is atomic: it ensures that 2 threads will not race together.
584 * @param req the request
585 * @param replace if not zero an existing value is replaced
586 * @param create_context the creation function or NULL
587 * @param free_context the destroying function or NULL
588 * @param closure the closure to the creation function
590 * @return the stored value
592 void *afb_req_context(
595 void *(*create_context)(void *closure),
596 void (*free_context)(void*),
600 ### afb_req_context_get
604 * Gets the pointer stored by the binding for the session of 'req'.
605 * When the binding has not yet recorded a pointer, NULL is returned.
607 * Shortcut for: afb_req_context(req, 0, NULL, NULL, NULL)
609 * @param req the request
611 * @return the previously stored value
613 void *afb_req_context_get(
617 ### afb_req_context_set
621 * Stores for the binding the pointer 'context' to the session of 'req'.
622 * The function 'free_context' will be called when the session is closed
623 * or if binding stores an other pointer.
625 * Shortcut for: afb_req_context(req, 1, NULL, free_context, context)
628 * @param req the request
629 * @param context the context value to store
630 * @param free_context the cleaning function for the stored context (can be NULL)
632 void afb_req_context_set(
635 void (*free_context)(void*));
638 ### afb_req_context_clear
642 * Frees the pointer stored by the binding for the session of 'req'
643 * and sets it to NULL.
645 * Shortcut for: afb_req_context_set(req, NULL, NULL)
647 * @param req the request
649 void afb_req_context_clear(
653 ### afb_req_session_close
657 * Closes the session associated with 'req'
658 * and delete all associated contexts.
660 * @param req the request
662 void afb_req_session_close(
666 ### afb_req_session_set_LOA
670 * Sets the level of assurance of the session of 'req'
671 * to 'level'. The effect of this function is subject of
674 * @param req the request
675 * @param level of assurance from 0 to 7
677 * @return 0 on success or -1 if failed.
679 int afb_req_session_set_LOA(
684 ## Credential/client functions
686 ### afb_req_has_permission
690 * Check whether the 'permission' is granted or not to the client
691 * identified by 'req'.
693 * @param req the request
694 * @param permission string to check
696 * @return 1 if the permission is granted or 0 otherwise.
698 int afb_req_has_permission(
700 const char *permission);
703 ### afb_req_get_application_id
707 * Get the application identifier of the client application for the
710 * Returns the application identifier or NULL when the application
711 * can not be identified.
713 * The returned value if not NULL must be freed by the caller
715 * @param req the request
717 * @return the string for the application id of the client MUST BE FREED
719 char *afb_req_get_application_id(
727 * Get the user identifier (UID) of the client for the
730 * @param req the request
732 * @return -1 when the application can not be identified or the unix uid.
739 ### afb_req_get_client_info
743 * Get informations about the client of the
746 * Returns an object with client informations:
748 * "pid": int, "uid": int, "gid": int,
749 * "label": string, "id": string, "user": string,
750 * "uuid": string, "LOA": int
753 * If some of this information can't be computed, the field of the return
754 * object will not be set at all.
756 * @param req the request
758 * @return a JSON object that must be freed using @ref json_object_put
760 struct json_object *afb_req_get_client_info(
766 ### afb_req_subcall_legacy
770 * @deprecated use @ref afb_req_subcall
772 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
773 * This call is made in the context of the request 'req'.
774 * On completion, the function 'callback' is invoked with the
775 * 'closure' given at call and two other parameters: 'iserror' and 'result'.
776 * 'status' is 0 on success or negative when on an error reply.
777 * 'result' is the json object of the reply, you must not call json_object_put
780 * For convenience, the function calls 'json_object_put' for 'args'.
781 * Thus, in the case where 'args' should remain available after
782 * the function returns, the function 'json_object_get' shall be used.
784 * @param req the request
785 * @param api the name of the api to call
786 * @param verb the name of the verb to call
787 * @param args the arguments of the call as a JSON object
788 * @param callback the call back that will receive the reply
789 * @param closure the closure passed back to the callback
791 * @see afb_req_subcall
792 * @see afb_req_subcall_sync
794 void afb_req_subcall_legacy(
798 struct json_object *args,
802 struct json_object *result,
807 ### afb_req_subcall_sync_legacy
811 * @deprecated use @ref afb_req_subcall_sync
813 * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
814 * This call is made in the context of the request 'req'.
815 * This call is synchronous, it waits until completion of the request.
816 * It returns 0 on success or a negative value on error answer.
817 * The object pointed by 'result' is filled and must be released by the caller
818 * after its use by calling 'json_object_put'.
820 * For convenience, the function calls 'json_object_put' for 'args'.
821 * Thus, in the case where 'args' should remain available after
822 * the function returns, the function 'json_object_get' shall be used.
824 * @param req the request
825 * @param api the name of the api to call
826 * @param verb the name of the verb to call
827 * @param args the arguments of the call as a JSON object
828 * @param result the pointer to the JSON object pointer that will receive the result
830 * @return 0 on success or a negative value on error answer.
832 * @see afb_req_subcall
833 * @see afb_req_subcall_sync
835 int afb_req_subcall_sync_legacy(
839 struct json_object *args,
840 struct json_object **result);