2 * Copyright (C) 2017 "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.
20 #include <afb/afb-request-itf.h>
21 #include "afb-context.h"
24 struct afb_evt_listener;
28 struct afb_api_dyn_verb;
30 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 (*success)(struct afb_xreq *xreq, struct json_object *obj, const char *info);
41 void (*fail)(struct afb_xreq *xreq, const char *status, const char *info);
42 void (*reply)(struct afb_xreq *xreq, int status, struct json_object *obj);
43 void (*unref)(struct afb_xreq *xreq);
44 int (*subscribe)(struct afb_xreq *xreq, struct afb_eventid *eventid);
45 int (*unsubscribe)(struct afb_xreq *xreq, struct afb_eventid *eventid);
47 struct afb_xreq *xreq,
50 struct json_object *args,
51 void (*callback)(void*, int, struct json_object*),
56 * Internal data for requests
60 struct afb_request request; /**< exported request */
61 struct afb_context context; /**< context of the request */
62 struct afb_apiset *apiset; /**< apiset of the xreq */
63 struct json_object *json; /**< the json object (or NULL) */
64 const struct afb_xreq_query_itf *queryitf; /**< interface of xreq implmentation functions */
65 int refcount; /**< current ref count */
66 int replied; /**< is replied? */
67 int hookflags; /**< flags for hooking */
68 int hookindex; /**< hook index of the request if hooked */
69 struct afb_evt_listener *listener; /**< event listener for the request */
70 struct afb_cred *cred; /**< client credential if revelant */
71 struct afb_xreq *caller; /**< caller request if any */
75 * Macro for retrieve the pointer of a structure of 'type' having a field named 'field'
77 * @param type the type that has the 'field' (ex: "struct mystruct")
78 * @param field the name of the field within the structure 'type'
79 * @param ptr the pointer to an element 'field'
80 * @return the pointer to the structure that contains the 'field' at address 'ptr'
82 #define CONTAINER_OF(type,field,ptr) ((type*)(((intptr_t)(ptr))-((intptr_t)&(((type*)NULL)->field))))
85 * Macro for retrieve the pointer of a structure of 'type' having a field named "xreq"
87 * @param type the type that has the field "xreq" (ex: "struct mystruct")
88 * @param x the pointer to the field "xreq"
89 * @return the pointer to the structure that contains the field "xreq" of address 'x'
91 #define CONTAINER_OF_XREQ(type,x) CONTAINER_OF(type,xreq,x)
93 /* req wrappers for xreq */
94 extern struct afb_req afb_xreq_unstore(struct afb_stored_req *sreq);
95 extern void afb_xreq_addref(struct afb_xreq *xreq);
96 extern void afb_xreq_unref(struct afb_xreq *xreq);
97 extern void afb_xreq_unhooked_addref(struct afb_xreq *xreq);
98 extern void afb_xreq_unhooked_unref(struct afb_xreq *xreq);
100 extern struct json_object *afb_xreq_json(struct afb_xreq *xreq);
102 extern void afb_xreq_success(struct afb_xreq *xreq, struct json_object *obj, const char *info);
103 extern void afb_xreq_success_f(struct afb_xreq *xreq, struct json_object *obj, const char *info, ...);
105 extern void afb_xreq_fail(struct afb_xreq *xreq, const char *status, const char *info);
106 extern void afb_xreq_fail_f(struct afb_xreq *xreq, const char *status, const char *info, ...);
107 extern void afb_xreq_fail_unknown_api(struct afb_xreq *xreq);
108 extern void afb_xreq_fail_unknown_verb(struct afb_xreq *xreq);
110 extern const char *afb_xreq_raw(struct afb_xreq *xreq, size_t *size);
112 extern int afb_xreq_subscribe(struct afb_xreq *xreq, struct afb_eventid *eventid);
113 extern int afb_xreq_unsubscribe(struct afb_xreq *xreq, struct afb_eventid *eventid);
115 extern void afb_xreq_subcall(
116 struct afb_xreq *xreq,
119 struct json_object *args,
120 void (*callback)(void*, int, struct json_object*, struct afb_request *),
122 extern void afb_xreq_unhooked_subcall(
123 struct afb_xreq *xreq,
126 struct json_object *args,
127 void (*callback)(void*, int, struct json_object*, struct afb_request *),
130 extern int afb_xreq_unhooked_subcall_sync(
131 struct afb_xreq *xreq,
134 struct json_object *args,
135 struct json_object **result);
136 extern int afb_xreq_subcall_sync(
137 struct afb_xreq *xreq,
140 struct json_object *args,
141 struct json_object **result);
143 /* initialisation and processing of xreq */
144 extern void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf);
146 extern void afb_xreq_process(struct afb_xreq *xreq, struct afb_apiset *apiset);
148 extern void afb_xreq_call_verb_v1(struct afb_xreq *xreq, const struct afb_verb_desc_v1 *verb);
149 extern void afb_xreq_call_verb_v2(struct afb_xreq *xreq, const struct afb_verb_v2 *verb);
150 extern void afb_xreq_call_verb_vdyn(struct afb_xreq *xreq, const struct afb_api_dyn_verb *verb);