X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-req-itf.h;h=6b6c8b70c7767fadab3d12f3b65b38265be712a0;hb=c710a0da4ebcc126275c42a0387ff85b2557e3ae;hp=3efb089df2d2771a0a16fd789fbc05225f79b1c9;hpb=6518887513840471ea9c5af7e534787717e6bd82;p=src%2Fapp-framework-binder.git

diff --git a/include/afb/afb-req-itf.h b/include/afb/afb-req-itf.h
index 3efb089d..6b6c8b70 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 <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +25,7 @@
 #include <stdarg.h>
 #include <stdio.h>
 
-#include <afb/afb-event-itf.h>
+#include "afb-event-itf.h"
 
 /* avoid inclusion of <json-c/json.h> */
 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 */
 
@@ -75,13 +75,23 @@ struct afb_req_itf {
 };
 
 /*
- * Describes the request by plugins from afb-daemon
+ * Describes the request by bindings from afb-daemon
  */
 struct afb_req {
 	const struct afb_req_itf *itf;	/* the interface to use */
 	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 +148,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 +161,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 +186,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 +199,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.
  */
@@ -206,8 +216,8 @@ static inline void afb_req_fail_f(struct afb_req req, const char *status, const
 }
 
 /*
- * Gets the pointer stored by the plugin for the session of 'req'.
- * When the plugin has not yet recorded a pointer, NULL is returned.
+ * Gets the pointer stored by the binding for the session of 'req'.
+ * When the binding has not yet recorded a pointer, NULL is returned.
  */
 static inline void *afb_req_context_get(struct afb_req req)
 {
@@ -215,9 +225,9 @@ static inline void *afb_req_context_get(struct afb_req req)
 }
 
 /*
- * Stores for the plugin the pointer 'context' to the session of 'req'.
+ * Stores for the binding the pointer 'context' to the session of 'req'.
  * The function 'free_context' will be called when the session is closed
- * or if plugin stores an other pointer.
+ * or if binding stores an other pointer.
  */
 static inline void afb_req_context_set(struct afb_req req, void *context, void (*free_context)(void*))
 {
@@ -225,7 +235,7 @@ static inline void afb_req_context_set(struct afb_req req, void *context, void (
 }
 
 /*
- * Gets the pointer stored by the plugin for the session of 'req'.
+ * Gets the pointer stored by the binding for the session of 'req'.
  * If the stored pointer is NULL, indicating that no pointer was
  * already stored, afb_req_context creates a new context by calling
  * the function 'create_context' and stores it with the freeing function
@@ -242,7 +252,7 @@ static inline void *afb_req_context(struct afb_req req, void *(*create_context)(
 }
 
 /*
- * Frees the pointer stored by the plugin for the session of 'req'
+ * Frees the pointer stored by the binding for the session of 'req'
  * and sets it to NULL.
  *
  * Shortcut for: afb_req_context_set(req, NULL, NULL)
@@ -300,7 +310,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);