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
|
/*
* 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
/* defined here */
struct afb_arg;
struct afb_request;
struct afb_request_itf;
/* referenced here */
#include <stdarg.h>
struct json_object;
struct afb_req;
struct afb_event;
struct afb_eventid;
struct afb_dynapi;
struct afb_stored_req;
/*
* Describes an argument (or parameter) of a request
*/
struct afb_arg
{
const char *name; /* name of the argument or NULL if invalid */
const char *value; /* string representation of the value of the argument */
/* original filename of the argument if path != NULL */
const char *path; /* if not NULL, path of the received file for the argument */
/* when the request is finalized this file is removed */
};
/*
* structure for the request
*/
struct afb_request
{
/* interface for the request */
const struct afb_request_itf *itf;
/* current dynapi if dynapi (is NULL for bindings v1 and v2) */
struct afb_dynapi *dynapi;
/* closure associated with the callback processing the verb of the request
* as given at its declaration */
void *vcbdata;
};
/*
* Interface for handling requests.
* It records the functions to be called for the request.
* Don't use this structure directly.
* Use the helper functions
*/
struct afb_request_itf
{
/* CAUTION: respect the order, add at the end */
struct json_object *(*json)(
struct afb_request *request);
struct afb_arg (*get)(
struct afb_request *request,
const char *name);
void (*success)(
struct afb_request *request,
struct json_object *obj,
const char *info);
void (*fail)(
struct afb_request *request,
const char *status,
const char *info);
void (*vsuccess)(
struct afb_request *request,
struct json_object *obj,
const char *fmt,
va_list args);
void (*vfail)(
struct afb_request *request,
const char *status,
const char *fmt,
va_list args);
void *(*context_get)(
struct afb_request *request);
void (*context_set)(
struct afb_request *request,
void *value,
void (*free_value)(void*));
struct afb_request *(*addref)(
struct afb_request *request);
void (*unref)(
struct afb_request *request);
void (*session_close)(
struct afb_request *request);
int (*session_set_LOA)(
struct afb_request *request,
unsigned level);
int (*subscribe)(
struct afb_request *request,
struct afb_event event);
int (*unsubscribe)(
struct afb_request *request,
struct afb_event event);
void (*subcall)(
struct afb_request *request,
const char *api,
const char *verb,
struct json_object *args,
void (*callback)(void*, int, struct json_object*),
void *cb_closure);
int (*subcallsync)(
struct afb_request *request,
const char *api,
const char *verb,
struct json_object *args,
struct json_object **result);
void (*vverbose)(
struct afb_request *request,
int level,
const char *file,
int line,
const char * func,
const char *fmt,
va_list args);
struct afb_stored_req *(*store)(
struct afb_request *request);
void (*subcall_req)(
struct afb_request *request,
const char *api,
const char *verb,
struct json_object *args,
void (*callback)(void*, int, struct json_object*, struct afb_req),
void *cb_closure);
int (*has_permission)(
struct afb_request *request,
const char *permission);
char *(*get_application_id)(
struct afb_request *request);
void *(*context_make)(
struct afb_request *request,
int replace,
void *(*create_value)(void *creation_closure),
void (*free_value)(void*),
void *creation_closure);
int (*subscribe_eventid)(
struct afb_request *request,
struct afb_eventid *eventid);
int (*unsubscribe_eventid)(
struct afb_request *request,
struct afb_eventid *eventid);
void (*subcall_request)(
struct afb_request *request,
const char *api,
const char *verb,
struct json_object *args,
void (*callback)(void*, int, struct json_object*, struct afb_request *request),
void *cb_closure);
};
|
