api-v3: First draft
[src/app-framework-binder.git] / src / afb-api-v3.h
1 /*
2  * Copyright (C) 2016, 2017, 2018 "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
19 #pragma once
20
21 struct afb_apiset;
22 struct afb_api_v3;
23 struct afb_api_x3;
24 struct afb_auth;
25 struct afb_req_x2;
26 struct afb_verb_v2;
27 struct afb_verb_v3;
28 struct afb_binding_v3;
29 struct afb_xreq;
30 struct json_object;
31 struct afb_export;
32
33 extern struct afb_api_v3 *afb_api_v3_create(
34                 struct afb_apiset *declare_set,
35                 struct afb_apiset *call_set,
36                 const char *apiname,
37                 const char *info,
38                 int noconcurrency,
39                 int (*preinit)(void*, struct afb_api_x3 *),
40                 void *closure,
41                 int copy_info
42 );
43
44 extern struct afb_api_v3 *afb_api_v3_from_binding(
45                 const struct afb_binding_v3 *desc,
46                 struct afb_apiset *declare_set,
47                 struct afb_apiset * call_set);
48
49 extern int afb_api_v3_set_binding_fields(const struct afb_binding_v3 *desc, struct afb_api_x3 *api);
50
51 extern struct afb_api_v3 *afb_api_v3_addref(struct afb_api_v3 *api);
52 extern void afb_api_v3_unref(struct afb_api_v3 *api);
53
54 extern struct afb_export *afb_api_v3_export(struct afb_api_v3 *api);
55
56 extern void afb_api_v3_set_verbs_v2(
57                 struct afb_api_v3 *api,
58                 const struct afb_verb_v2 *verbs);
59
60 extern void afb_api_v3_set_verbs_v3(
61                 struct afb_api_v3 *api,
62                 const struct afb_verb_v3 *verbs);
63
64 extern int afb_api_v3_add_verb(
65                 struct afb_api_v3 *api,
66                 const char *verb,
67                 const char *info,
68                 void (*callback)(struct afb_req_x2 *req),
69                 void *vcbdata,
70                 const struct afb_auth *auth,
71                 uint16_t session,
72                 int glob);
73
74 extern int afb_api_v3_del_verb(
75                 struct afb_api_v3 *api,
76                 const char *verb,
77                 void **vcbdata);
78
79 extern void afb_api_v3_process_call(struct afb_api_v3 *api, struct afb_xreq *xreq);
80 extern struct json_object *afb_api_v3_make_description_openAPIv3(struct afb_api_v3 *api, const char *apiname);
81