Add ability to provide binding settings
[src/app-framework-binder.git] / src / afb-export.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 #pragma once
19
20 struct json_object;
21
22 struct afb_export;
23 struct afb_apiset;
24 struct afb_context;
25 struct afb_xreq;
26
27 struct afb_binding_v2;
28 struct afb_binding_data_v2;
29 struct afb_api_v3;
30 struct afb_api_x3;
31 struct afb_event_x2;
32
33 extern void afb_export_set_config(struct json_object *config);
34
35 extern struct afb_export *afb_export_create_none_for_path(
36                                 struct afb_apiset *declare_set,
37                                 struct afb_apiset *call_set,
38                                 const char *path,
39                                 int (*creator)(void*, struct afb_api_x3*),
40                                 void *closure);
41
42 extern struct afb_export *afb_export_create_v2(
43                                 struct afb_apiset *declare_set,
44                                 struct afb_apiset *call_set,
45                                 const char *apiname,
46                                 const struct afb_binding_v2 *binding,
47                                 struct afb_binding_data_v2 *data,
48                                 int (*init)(),
49                                 void (*onevent)(const char*, struct json_object*));
50
51 extern struct afb_export *afb_export_create_v3(struct afb_apiset *declare_set,
52                                 struct afb_apiset *call_set,
53                                 const char *apiname,
54                                 struct afb_api_v3 *api);
55
56 extern struct afb_export *afb_export_addref(struct afb_export *export);
57 extern void afb_export_unref(struct afb_export *export);
58
59 extern void afb_export_destroy(struct afb_export *export);
60
61 extern int afb_export_declare(struct afb_export *export, int noconcurrency);
62 extern void afb_export_undeclare(struct afb_export *export);
63
64 extern const char *afb_export_apiname(const struct afb_export *export);
65 extern int afb_export_add_alias(struct afb_export *export, const char *apiname, const char *aliasname);
66 extern int afb_export_rename(struct afb_export *export, const char *apiname);
67 extern void afb_export_update_hooks(struct afb_export *export);
68
69 extern int afb_export_unshare_session(struct afb_export *export);
70
71 extern int afb_export_preinit_x3(
72                                 struct afb_export *export,
73                                 int (*preinit)(void *,struct afb_api_x3*),
74                                 void *closure);
75
76 extern int afb_export_handle_events_v12(
77                                 struct afb_export *export,
78                                 void (*on_event)(const char *event, struct json_object *object));
79
80
81 extern int afb_export_handle_events_v3(
82                                 struct afb_export *export,
83                                 void (*on_event)(struct afb_api_x3 *api, const char *event, struct json_object *object));
84
85
86 extern int afb_export_handle_init_v3(
87                                 struct afb_export *export,
88                                 int (*oninit)(struct afb_api_x3 *api));
89
90 extern int afb_export_start(struct afb_export *export);
91
92 extern int afb_export_logmask_get(const struct afb_export *export);
93 extern void afb_export_logmask_set(struct afb_export *export, int mask);
94
95 extern void *afb_export_userdata_get(const struct afb_export *export);
96 extern void afb_export_userdata_set(struct afb_export *export, void *data);
97
98 extern int afb_export_event_handler_add(
99                         struct afb_export *export,
100                         const char *pattern,
101                         void (*callback)(void *, const char*, struct json_object*, struct afb_api_x3*),
102                         void *closure);
103
104 extern int afb_export_event_handler_del(
105                         struct afb_export *export,
106                         const char *pattern,
107                         void **closure);
108
109 extern int afb_export_subscribe(struct afb_export *export, struct afb_event_x2 *event);
110 extern int afb_export_unsubscribe(struct afb_export *export, struct afb_event_x2 *event);
111 extern void afb_export_process_xreq(struct afb_export *export, struct afb_xreq *xreq);
112 extern void afb_export_context_init(struct afb_export *export, struct afb_context *context);
113 extern struct afb_export *afb_export_from_api_x3(struct afb_api_x3 *api);
114 extern struct afb_api_x3 *afb_export_to_api_x3(struct afb_export *export);
115
116 #if defined(WITH_LEGACY_BINDING_V1)
117
118 struct afb_service_x1;
119 struct afb_binding_interface_v1;
120
121 extern struct afb_export *afb_export_create_v1(
122                                 struct afb_apiset *declare_set,
123                                 struct afb_apiset *call_set,
124                                 const char *apiname,
125                                 int (*init)(struct afb_service_x1),
126                                 void (*onevent)(const char*, struct json_object*));
127
128 extern struct afb_binding_v1 *afb_export_register_v1(
129                                 struct afb_export *export,
130                                 struct afb_binding_v1 *(*regfun)(const struct afb_binding_interface_v1*));
131
132 #endif
133