summaryrefslogtreecommitdiffstats
path: root/include/afb/afb-service-itf.h
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-03-29 18:09:38 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2017-03-29 18:09:38 +0200
commite94995611bd4e05a2aac1c0ae7c7f0855137b78a (patch)
tree5d05cdeabb3698c7b53520bbaf9aa2aa143bf492 /include/afb/afb-service-itf.h
parentb6b049eac4035c2ef581205af8eccce93f5727b3 (diff)
Prepare migration to binding v2
Change-Id: I48c1fdb5199c9fb0f001576ceed3ddcb50fc9066 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-service-itf.h')
-rw-r--r--include/afb/afb-service-itf.h50
1 files changed, 21 insertions, 29 deletions
diff --git a/include/afb/afb-service-itf.h b/include/afb/afb-service-itf.h
index 7b5d8f23..321fa5ac 100644
--- a/include/afb/afb-service-itf.h
+++ b/include/afb/afb-service-itf.h
@@ -30,7 +30,8 @@ struct afb_service_itf
{
/* CAUTION: respect the order, add at the end */
- void (*call)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *callback_closure);
+ void (*call)(void *closure, const char *api, const char *verb, struct json_object *args,
+ void (*callback)(void*, int, struct json_object*), void *callback_closure);
};
/*
@@ -42,44 +43,35 @@ struct afb_service
void *closure;
};
-/*
- * When a binding have an exported implementation of the
- * function 'afbBindingV1ServiceInit', defined below,
- * the framework calls it for initialising the service after
- * registration of all bindings.
- *
- * The object 'service' should be recorded. It has functions that
- * allows the binding to call features with its own personality.
- *
- * The function should return 0 in case of success or, else, should return
- * a negative value.
- */
-extern int afbBindingV1ServiceInit(struct afb_service service);
-
-/*
- * When a binding have an implementation of the function 'afbBindingV1ServiceEvent',
- * defined below, the framework calls that function for any broadcasted event or for
- * events that the service subscribed to in its name.
- *
- * It receive the 'event' name and its related data in 'object' (be aware that 'object'
- * might be NULL).
- */
-extern void afbBindingV1ServiceEvent(const char *event, struct json_object *object);
+#include "afb-service-itf-v1.h"
-/*
+/**
* Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
* The result of the call is delivered to the 'callback' function with the 'callback_closure'.
*
- * The 'callcack' receives 3 arguments:
+ * The 'callback' receives 3 arguments:
* 1. 'closure' the user defined closure pointer 'callback_closure',
* 2. 'iserror' a boolean status being true (not null) when an error occured,
* 2. 'result' the resulting data as a JSON object.
*
- * See also 'afb_req_subcall'
+ * @param service The service as received during initialisation
+ * @param api The api name of the method to call
+ * @param verb The verb name of the method to call
+ * @param args The arguments to pass to the method
+ * @param callback The to call on completion
+ * @param callback_closure The closure to pass to the callback
+ *
+ * @returns 0 in case of success or -1 in case of error.
*
- * Returns 0in case of success or -1 in case of error.
+ * @see also 'afb_req_subcall'
*/
-static inline void afb_service_call(struct afb_service service, const char *api, const char *verb, struct json_object *args, void (*callback)(void*closure, int iserror, struct json_object *result), void *callback_closure)
+static inline void afb_service_call(
+ struct afb_service service,
+ const char *api,
+ const char *verb,
+ struct json_object *args,
+ void (*callback)(void*closure, int iserror, struct json_object *result),
+ void *callback_closure)
{
service.itf->call(service.closure, api, verb, args, callback, callback_closure);
}