1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/*
* 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
#include "afb-session-v1.h"
struct json_object;
struct afb_service;
struct afb_binding_v1;
struct afb_binding_interface_v1;
/*
* Function for registering the binding
*
* A binding V1 MUST have an exported function of name
*
* afbBindingV1Register
*
* This function is called during loading of the binding. It
* receives an 'interface' that should be recorded for later access to
* functions provided by the framework.
*
* This function MUST return the address of a structure that describes
* the binding and its implemented verbs.
*
* In case of initialisation error, NULL must be returned.
*
* Be aware that the given 'interface' is not fully functionnal
* because no provision is given to the name and description
* of the binding. Check the function 'afbBindingV1ServiceInit'
* defined in the file <afb/afb-service-itf.h> because when
* the function 'afbBindingV1ServiceInit' is called, the 'interface'
* is fully functionnal.
*/
extern const struct afb_binding_v1 *afbBindingV1Register (const struct afb_binding_interface_v1 *interface);
/*
* When a binding have an exported implementation of the
* function 'afbBindingV1ServiceInit', defined below,
* the framework calls it for initialising the service after
* registration of all bindings.
*
* The object 'service' should be recorded. It has functions that
* allows the binding to call features with its own personality.
*
* The function should return 0 in case of success or, else, should return
* a negative value.
*/
extern int afbBindingV1ServiceInit(struct afb_service service);
/*
* When a binding have an implementation of the function 'afbBindingV1ServiceEvent',
* defined below, the framework calls that function for any broadcasted event or for
* events that the service subscribed to in its name.
*
* It receive the 'event' name and its related data in 'object' (be aware that 'object'
* might be NULL).
*/
extern void afbBindingV1ServiceEvent(const char *event, struct json_object *object);
/*
* Description of one verb of the API provided by the binding
* This enumeration is valid for bindings of type version 1
*/
struct afb_verb_desc_v1
{
const char *name; /* name of the verb */
enum afb_session_flags_v1 session; /* authorisation and session requirements of the verb */
void (*callback)(struct afb_req req); /* callback function implementing the verb */
const char *info; /* textual description of the verb */
};
/*
* Description of the bindings of type version 1
*/
struct afb_binding_desc_v1
{
const char *info; /* textual information about the binding */
const char *prefix; /* required prefix name for the binding */
const struct afb_verb_desc_v1 *verbs; /* array of descriptions of verbs terminated by a NULL name */
};
/*
* Definition of the type+versions of the binding.
* The definition uses hashes.
*/
enum afb_binding_type_v1
{
AFB_BINDING_VERSION_1 = 123456789
};
/*
* Description of a binding
*/
struct afb_binding_v1
{
enum afb_binding_type_v1 type; /* type of the binding */
union {
struct afb_binding_desc_v1 v1; /* description of the binding of type 1 */
};
};
/*
* config mode
*/
enum afb_mode_v1 {
AFB_MODE_LOCAL = 0, /* run locally */
AFB_MODE_REMOTE, /* run remotely */
AFB_MODE_GLOBAL /* run either remotely or locally (DONT USE! reserved for future) */
};
/*
* Interface between the daemon and the binding.
*/
struct afb_binding_interface_v1
{
struct afb_daemon daemon; /* access to the daemon facilies */
int verbosity; /* level of verbosity */
enum afb_mode_v1 mode; /* run mode (local or remote) */
};
/*
* Macros for logging messages
*/
#if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_DETAILS)
# define AFB_ERROR_V1(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,__FILE__,__LINE__,__VA_ARGS__);}while(0)
# define AFB_WARNING_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,__FILE__,__LINE__,__VA_ARGS__);}while(0)
# define AFB_NOTICE_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,__FILE__,__LINE__,__VA_ARGS__);}while(0)
# define AFB_INFO_V1(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,__FILE__,__LINE__,__VA_ARGS__);}while(0)
# define AFB_DEBUG_V1(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,__FILE__,__LINE__,__VA_ARGS__);}while(0)
# else
# define AFB_ERROR_V1(itf,...) do{if(itf->verbosity>=0)afb_daemon_verbose(itf->daemon,3,NULL,0,__VA_ARGS__);}while(0)
# define AFB_WARNING_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,4,NULL,0,__VA_ARGS__);}while(0)
# define AFB_NOTICE_V1(itf,...) do{if(itf->verbosity>=1)afb_daemon_verbose(itf->daemon,5,NULL,0,__VA_ARGS__);}while(0)
# define AFB_INFO_V1(itf,...) do{if(itf->verbosity>=2)afb_daemon_verbose(itf->daemon,6,NULL,0,__VA_ARGS__);}while(0)
# define AFB_DEBUG_V1(itf,...) do{if(itf->verbosity>=3)afb_daemon_verbose(itf->daemon,7,NULL,0,__VA_ARGS__);}while(0)
# endif
#endif
/***************************************************************************************************/
#if AFB_BINDING_VERSION == 1
# define afb_binding afb_binding_v1
# define afb_binding_interface afb_binding_interface_v1
# define AFB_SESSION_NONE AFB_SESSION_NONE_V1
# define AFB_SESSION_CREATE AFB_SESSION_CREATE_V1
# define AFB_SESSION_CLOSE AFB_SESSION_CLOSE_V1
# define AFB_SESSION_RENEW AFB_SESSION_RENEW_V1
# define AFB_SESSION_CHECK AFB_SESSION_CHECK_V1
# define AFB_SESSION_LOA_GE AFB_SESSION_LOA_GE_V1
# define AFB_SESSION_LOA_LE AFB_SESSION_LOA_LE_V1
# define AFB_SESSION_LOA_EQ AFB_SESSION_LOA_EQ_V1
# define AFB_SESSION_LOA_SHIFT AFB_SESSION_LOA_SHIFT_V1
# define AFB_SESSION_LOA_MASK AFB_SESSION_LOA_MASK_V1
# define AFB_SESSION_LOA_0 AFB_SESSION_LOA_0_V1
# define AFB_SESSION_LOA_1 AFB_SESSION_LOA_1_V1
# define AFB_SESSION_LOA_2 AFB_SESSION_LOA_2_V1
# define AFB_SESSION_LOA_3 AFB_SESSION_LOA_3_V1
# define AFB_SESSION_LOA_4 AFB_SESSION_LOA_4_V1
# define AFB_SESSION_LOA_LE_0 AFB_SESSION_LOA_LE_0_V1
# define AFB_SESSION_LOA_LE_1 AFB_SESSION_LOA_LE_1_V1
# define AFB_SESSION_LOA_LE_2 AFB_SESSION_LOA_LE_2_V1
# define AFB_SESSION_LOA_LE_3 AFB_SESSION_LOA_LE_3_V1
# define AFB_SESSION_LOA_EQ_0 AFB_SESSION_LOA_EQ_0_V1
# define AFB_SESSION_LOA_EQ_1 AFB_SESSION_LOA_EQ_1_V1
# define AFB_SESSION_LOA_EQ_2 AFB_SESSION_LOA_EQ_2_V1
# define AFB_SESSION_LOA_EQ_3 AFB_SESSION_LOA_EQ_3_V1
# define AFB_SESSION_LOA_GE_0 AFB_SESSION_LOA_GE_0_V1
# define AFB_SESSION_LOA_GE_1 AFB_SESSION_LOA_GE_1_V1
# define AFB_SESSION_LOA_GE_2 AFB_SESSION_LOA_GE_2_V1
# define AFB_SESSION_LOA_GE_3 AFB_SESSION_LOA_GE_3_V1
# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
# define ERROR AFB_ERROR_V1
# define WARNING AFB_WARNING_V1
# define NOTICE AFB_NOTICE_V1
# define INFO AFB_INFO_V1
# define DEBUG AFB_DEBUG_V1
# endif
#endif
|
