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.
21 #define NO_BINDING_VERBOSE_MACRO
22 #include <afb/afb-binding.h>
23 #include "afb-context.h"
27 struct afb_evt_listener;
32 struct afb_xreq_query_itf {
33 struct json_object *(*json)(struct afb_xreq *xreq);
34 struct afb_arg (*get)(struct afb_xreq *xreq, const char *name);
35 void (*success)(struct afb_xreq *xreq, struct json_object *obj, const char *info);
36 void (*fail)(struct afb_xreq *xreq, const char *status, const char *info);
37 void (*reply)(struct afb_xreq *xreq, int iserror, struct json_object *obj);
38 void (*unref)(struct afb_xreq *xreq);
39 int (*subscribe)(struct afb_xreq *xreq, struct afb_event event);
40 int (*unsubscribe)(struct afb_xreq *xreq, struct afb_event event);
42 struct afb_xreq *xreq,
45 struct json_object *args,
46 void (*callback)(void*, int, struct json_object*),
51 * Internal data for requests
55 struct afb_context context; /**< context of the request */
56 struct afb_apiset *apiset; /**< apiset of the xreq */
57 const char *api; /**< the requested API */
58 const char *verb; /**< the requested VERB */
59 struct json_object *json; /**< the json object (or NULL) */
60 const struct afb_xreq_query_itf *queryitf; /**< interface of xreq implmentation functions */
61 int refcount; /**< current ref count */
62 int replied; /**< is replied? */
63 int hookflags; /**< flags for hooking */
64 int hookindex; /**< index for hooking */
65 struct afb_evt_listener *listener; /**< event listener for the request */
66 struct afb_cred *cred; /**< client credential if revelant */
70 * Macro for retrieve the pointer of a structure of 'type' having a field named 'field'
72 * @param type the type that has the 'field' (ex: "struct mystruct")
73 * @param field the name of the field within the structure 'type'
74 * @param ptr the pointer to an element 'field'
75 * @return the pointer to the structure that contains the 'field' at address 'ptr'
77 #define CONTAINER_OF(type,field,ptr) ((type*)(((intptr_t)(ptr))-((intptr_t)&(((type*)NULL)->field))))
80 * Macro for retrieve the pointer of a structure of 'type' having a field named "xreq"
82 * @param type the type that has the field "xreq" (ex: "struct mystruct")
83 * @param x the pointer to the field "xreq"
84 * @return the pointer to the structure that contains the field "xreq" of address 'x'
86 #define CONTAINER_OF_XREQ(type,x) CONTAINER_OF(type,xreq,x)
88 /* req wrappers for xreq */
89 extern void afb_xreq_addref(struct afb_xreq *xreq);
90 extern void afb_xreq_unref(struct afb_xreq *xreq);
92 extern struct json_object *afb_xreq_json(struct afb_xreq *xreq);
94 extern void afb_xreq_success(struct afb_xreq *xreq, struct json_object *obj, const char *info);
95 extern void afb_xreq_success_f(struct afb_xreq *xreq, struct json_object *obj, const char *info, ...);
97 extern void afb_xreq_fail(struct afb_xreq *xreq, const char *status, const char *info);
98 extern void afb_xreq_fail_f(struct afb_xreq *xreq, const char *status, const char *info, ...);
99 extern void afb_xreq_fail_unknown_api(struct afb_xreq *xreq);
100 extern void afb_xreq_fail_unknown_verb(struct afb_xreq *xreq);
102 extern const char *afb_xreq_raw(struct afb_xreq *xreq, size_t *size);
104 extern int afb_xreq_subscribe(struct afb_xreq *xreq, struct afb_event event);
105 extern int afb_xreq_unsubscribe(struct afb_xreq *xreq, struct afb_event event);
107 extern void afb_xreq_subcall(
108 struct afb_xreq *xreq,
111 struct json_object *args,
112 void (*callback)(void*, int, struct json_object*),
114 extern void afb_xreq_unhooked_subcall(
115 struct afb_xreq *xreq,
118 struct json_object *args,
119 void (*callback)(void*, int, struct json_object*),
122 /* initialisation and processing of xreq */
123 extern void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf);
125 extern void afb_xreq_process(struct afb_xreq *xreq, struct afb_apiset *apiset);
127 extern int xreq_session_check(struct afb_xreq *xreq, int sessionflags);
128 extern void xreq_session_apply(struct afb_xreq *xreq, int sessionflags);
129 extern int xreq_session_check_apply(struct afb_xreq *xreq, int sessionflags);
131 extern void afb_xreq_call(struct afb_xreq *xreq, void (*callback)(struct afb_req req));
132 extern void afb_xreq_check_apply_call(struct afb_xreq *xreq, int sessionflags, void (*callback)(struct afb_req req));