Update copyright dates

[src/app-framework-binder.git] / include / afb / afb-service-v1.h

diff --git a/include/afb/afb-service-v1.h b/include/afb/afb-service-v1.h
index f3f55a5..331f28a 100644 (file)
--- a/include/afb/afb-service-v1.h
+++ b/include/afb/afb-service-v1.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Copyright (C) 2015-2020 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,7 +17,14 @@
 
 #pragma once
 
+#include "afb-service-itf-x1.h"
+
+/** @addtogroup AFB_SERVICE
+ *  @{ */
+
 /**
+ * @deprecated use bindings version 3
+ *
  * 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'.
  *
@@ -27,7 +34,7 @@
  *
  * 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. 'status' a status being 0 on success or negative when an error occured,
  *  2. 'result' the resulting data as a JSON object.
  *
  * @param service  The service as received during initialisation
@@ -40,17 +47,19 @@
  * @see also 'afb_req_subcall'
  */
 static inline void afb_service_call_v1(
-       struct afb_service service,
+       struct afb_service_x1 service,
        const char *api,
        const char *verb,
        struct json_object *args,
-       void (*callback)(void*closure, int iserror, struct json_object *result),
+       void (*callback)(void*closure, int status, struct json_object *result),
        void *callback_closure)
 {
        service.itf->call(service.closure, api, verb, args, callback, callback_closure);
 }
 
 /**
+ * @deprecated use bindings version 3
+ *
  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
  * 'result' will receive the response.
  *
@@ -64,12 +73,12 @@ static inline void afb_service_call_v1(
  * @param args     The arguments to pass to the method
  * @param result   Where to store the result - should call json_object_put on it -
  *
- * @returns 1 in case of success or 0 in case of error.
+ * @returns 0 in case of success or a negative value in case of error.
  *
  * @see also 'afb_req_subcall'
  */
 static inline int afb_service_call_sync_v1(
-       struct afb_service service,
+       struct afb_service_x1 service,
        const char *api,
        const char *verb,
        struct json_object *args,
@@ -78,3 +87,4 @@ static inline int afb_service_call_sync_v1(
        return service.itf->call_sync(service.closure, api, verb, args, result);
 }
 
+/** @} */