Provide API and VERB name of requests
[src/app-framework-binder.git] / include / afb / afb-service-common.h
1 /*
2  * Copyright (C) 2016, 2017 "IoT.bzh"
3  * Author: José Bollo <jose.bollo@iot.bzh>
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #pragma once
19
20 /* avoid inclusion of <json-c/json.h> */
21 struct json_object;
22
23 /*
24  * Interface for internal of services
25  * It records the functions to be called for the request.
26  * Don't use this structure directly.
27  * Use the helper functions documented below.
28  */
29 struct afb_service_itf
30 {
31         /* CAUTION: respect the order, add at the end */
32
33         void (*call)(void *closure, const char *api, const char *verb, struct json_object *args,
34                      void (*callback)(void*, int, struct json_object*), void *callback_closure);
35
36         int (*call_sync)(void *closure, const char *api, const char *verb, struct json_object *args,
37                          struct json_object **result);
38 };
39
40 /*
41  * Object that encapsulate accesses to service items
42  */
43 struct afb_service
44 {
45         const struct afb_service_itf *itf;
46         void *closure;
47 };
48