aboutsummaryrefslogtreecommitdiffstats
path: root/include/afb/afb-service-v1.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/afb/afb-service-v1.h')
-rw-r--r--include/afb/afb-service-v1.h50
1 files changed, 50 insertions, 0 deletions
diff --git a/include/afb/afb-service-v1.h b/include/afb/afb-service-v1.h
new file mode 100644
index 00000000..6e85a293
--- /dev/null
+++ b/include/afb/afb-service-v1.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2016, 2017 "IoT.bzh"
+ * Author: José Bollo <jose.bollo@iot.bzh>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+/**
+ * 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 '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.
+ *
+ * @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.
+ *
+ * @see also 'afb_req_subcall'
+ */
+static inline void afb_service_call_v1(
+ 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);
+}
+