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