2 * Copyright (C) 2017, 2018 "IoT.bzh"
3 * Author José Bollo <jose.bollo@iot.bzh>
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <afb/afb-req-x1-itf.h>
22 #include <afb/afb-req-x2-itf.h>
23 #include "afb-context.h"
26 struct afb_evt_listener;
31 struct afb_verb_desc_v1;
35 struct afb_stored_req;
37 struct afb_xreq_query_itf {
38 struct json_object *(*json)(struct afb_xreq *xreq);
39 struct afb_arg (*get)(struct afb_xreq *xreq, const char *name);
40 void (*reply)(struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info);
41 void (*unref)(struct afb_xreq *xreq);
42 int (*subscribe)(struct afb_xreq *xreq, struct afb_event_x2 *event);
43 int (*unsubscribe)(struct afb_xreq *xreq, struct afb_event_x2 *event);
47 * Internal data for requests
51 struct afb_req_x2 request; /**< exported request */
52 struct afb_context context; /**< context of the request */
53 struct afb_apiset *apiset; /**< apiset of the xreq */
54 struct json_object *json; /**< the json object (or NULL) */
55 const struct afb_xreq_query_itf *queryitf; /**< interface of xreq implementation functions */
56 int refcount; /**< current ref count */
57 int replied; /**< is replied? */
58 int hookflags; /**< flags for hooking */
59 int hookindex; /**< hook index of the request if hooked */
60 struct afb_evt_listener *listener; /**< event listener for the request */
61 struct afb_cred *cred; /**< client credential if revelant */
62 struct afb_xreq *caller; /**< caller request if any */
66 * Macro for retrieve the pointer of a structure of 'type' having a field named 'field'
68 * @param type the type that has the 'field' (ex: "struct mystruct")
69 * @param field the name of the field within the structure 'type'
70 * @param ptr the pointer to an element 'field'
71 * @return the pointer to the structure that contains the 'field' at address 'ptr'
73 #define CONTAINER_OF(type,field,ptr) ((type*)(((char*)(ptr))-((char*)&(((type*)NULL)->field))))
76 * Macro for retrieve the pointer of a structure of 'type' having a field named "xreq"
78 * @param type the type that has the field "xreq" (ex: "struct mystruct")
79 * @param x the pointer to the field "xreq"
80 * @return the pointer to the structure that contains the field "xreq" of address 'x'
82 #define CONTAINER_OF_XREQ(type,x) CONTAINER_OF(type,xreq,x)
84 /* req wrappers for xreq */
85 extern struct afb_req_x1 afb_xreq_unstore(struct afb_stored_req *sreq);
86 extern void afb_xreq_addref(struct afb_xreq *xreq);
87 extern void afb_xreq_unref(struct afb_xreq *xreq);
88 extern void afb_xreq_unhooked_addref(struct afb_xreq *xreq);
89 extern void afb_xreq_unhooked_unref(struct afb_xreq *xreq);
91 extern struct json_object *afb_xreq_unhooked_json(struct afb_xreq *xreq);
92 extern struct json_object *afb_xreq_json(struct afb_xreq *xreq);
94 extern void afb_xreq_reply(struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info);
95 extern void afb_xreq_reply_f(struct afb_xreq *xreq, struct json_object *obj, const char *error, const char *info, ...);
97 extern void afb_xreq_reply_unknown_api(struct afb_xreq *xreq);
98 extern void afb_xreq_reply_unknown_verb(struct afb_xreq *xreq);
100 extern const char *afb_xreq_raw(struct afb_xreq *xreq, size_t *size);
102 extern int afb_xreq_subscribe(struct afb_xreq *xreq, struct afb_event_x2 *event);
103 extern int afb_xreq_unsubscribe(struct afb_xreq *xreq, struct afb_event_x2 *event);
105 extern void afb_xreq_legacy_subcall(
106 struct afb_xreq *xreq,
109 struct json_object *args,
110 void (*callback)(void*, int, struct json_object*, struct afb_req_x2 *),
112 extern void afb_xreq_unhooked_legacy_subcall(
113 struct afb_xreq *xreq,
116 struct json_object *args,
117 void (*callback)(void*, int, struct json_object*, struct afb_req_x2 *),
120 extern void afb_xreq_subcall(
121 struct afb_xreq *xreq,
124 struct json_object *args,
126 void (*callback)(void*, struct json_object*, const char*, const char*, struct afb_req_x2 *),
128 extern void afb_xreq_unhooked_subcall(
129 struct afb_xreq *xreq,
132 struct json_object *args,
134 void (*callback)(void*, struct json_object*, const char*, const char*, struct afb_req_x2 *),
137 extern int afb_xreq_unhooked_legacy_subcall_sync(
138 struct afb_xreq *xreq,
141 struct json_object *args,
142 struct json_object **result);
143 extern int afb_xreq_legacy_subcall_sync(
144 struct afb_xreq *xreq,
147 struct json_object *args,
148 struct json_object **result);
150 /* initialisation and processing of xreq */
151 extern void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf);
153 extern void afb_xreq_process(struct afb_xreq *xreq, struct afb_apiset *apiset);
155 extern void afb_xreq_call_verb_v1(struct afb_xreq *xreq, const struct afb_verb_desc_v1 *verb);
156 extern void afb_xreq_call_verb_v2(struct afb_xreq *xreq, const struct afb_verb_v2 *verb);
157 extern void afb_xreq_call_verb_v3(struct afb_xreq *xreq, const struct afb_verb_v3 *verb);
159 extern const char *xreq_on_behalf_cred_export(struct afb_xreq *xreq);
161 /******************************************************************************/
163 static inline struct afb_req_x1 xreq_to_req_x1(struct afb_xreq *xreq)
165 return (struct afb_req_x1){ .itf = xreq->request.itf, .closure = &xreq->request };
168 static inline struct afb_req_x2 *xreq_to_req_x2(struct afb_xreq *xreq)
170 return &xreq->request;
173 static inline struct afb_xreq *xreq_from_req_x2(struct afb_req_x2 *req)
175 return CONTAINER_OF(struct afb_xreq, request, req);