src/afb-xreq.h

   1 /*
   2  * Copyright (C) 2017 "IoT.bzh"
   3  * Author José Bollo <jose.bollo@iot.bzh>
   4  *
   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
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 #pragma once
  19
  20 #include <afb/afb-request-itf.h>
  21 #include "afb-context.h"
  22
  23 struct json_object;
  24 struct afb_evt_listener;
  25 struct afb_xreq;
  26 struct afb_cred;
  27 struct afb_apiset;
  28 struct afb_api_dyn_verb;
  29 struct afb_eventid;
  30 struct afb_verb_desc_v1;
  31 struct afb_verb_v2;
  32 struct afb_req;
  33 struct afb_req_itf;
  34 struct afb_request;
  35 struct afb_stored_req;
  36
  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);
  46         void (*subcall)(
  47                 struct afb_xreq *xreq,
  48                 const char *api,
  49                 const char *verb,
  50                 struct json_object *args,
  51                 void (*callback)(void*, int, struct json_object*),
  52                 void *cb_closure);
  53 };
  54
  55 /**
  56  * Internal data for requests
  57  */
  58 struct afb_xreq
  59 {
  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         const char *api;                /**< the requested API */
  64         const char *verb;               /**< the requested VERB */
  65         struct json_object *json;       /**< the json object (or NULL) */
  66         const struct afb_xreq_query_itf *queryitf; /**< interface of xreq implmentation functions */
  67         int refcount;                   /**< current ref count */
  68         int replied;                    /**< is replied? */
  69         int hookflags;                  /**< flags for hooking */
  70         int hookindex;                  /**< hook index of the request if hooked */
  71         struct afb_evt_listener *listener; /**< event listener for the request */
  72         struct afb_cred *cred;          /**< client credential if revelant */
  73         struct afb_xreq *caller;        /**< caller request if any */
  74 };
  75
  76 /**
  77  * Macro for retrieve the pointer of a structure of 'type' having a field named 'field'
  78  * of adress 'ptr'.
  79  * @param type the type that has the 'field' (ex: "struct mystruct")
  80  * @param field the name of the field within the structure 'type'
  81  * @param ptr the pointer to an element 'field'
  82  * @return the pointer to the structure that contains the 'field' at address 'ptr'
  83  */
  84 #define CONTAINER_OF(type,field,ptr) ((type*)(((intptr_t)(ptr))-((intptr_t)&(((type*)NULL)->field))))
  85
  86 /**
  87  * Macro for retrieve the pointer of a structure of 'type' having a field named "xreq"
  88  * of adress 'x'.
  89  * @param type the type that has the field "xreq" (ex: "struct mystruct")
  90  * @param x the pointer to the field "xreq"
  91  * @return the pointer to the structure that contains the field "xreq" of address 'x'
  92  */
  93 #define CONTAINER_OF_XREQ(type,x) CONTAINER_OF(type,xreq,x)
  94
  95 /* req wrappers for xreq */
  96 extern struct afb_req afb_xreq_unstore(struct afb_stored_req *sreq);
  97 extern void afb_xreq_addref(struct afb_xreq *xreq);
  98 extern void afb_xreq_unref(struct afb_xreq *xreq);
  99 extern void afb_xreq_unhooked_addref(struct afb_xreq *xreq);
 100 extern void afb_xreq_unhooked_unref(struct afb_xreq *xreq);
 101
 102 extern struct json_object *afb_xreq_json(struct afb_xreq *xreq);
 103
 104 extern void afb_xreq_success(struct afb_xreq *xreq, struct json_object *obj, const char *info);
 105 extern void afb_xreq_success_f(struct afb_xreq *xreq, struct json_object *obj, const char *info, ...);
 106
 107 extern void afb_xreq_fail(struct afb_xreq *xreq, const char *status, const char *info);
 108 extern void afb_xreq_fail_f(struct afb_xreq *xreq, const char *status, const char *info, ...);
 109 extern void afb_xreq_fail_unknown_api(struct afb_xreq *xreq);
 110 extern void afb_xreq_fail_unknown_verb(struct afb_xreq *xreq);
 111
 112 extern const char *afb_xreq_raw(struct afb_xreq *xreq, size_t *size);
 113
 114 extern int afb_xreq_subscribe(struct afb_xreq *xreq, struct afb_eventid *eventid);
 115 extern int afb_xreq_unsubscribe(struct afb_xreq *xreq, struct afb_eventid *eventid);
 116
 117 extern void afb_xreq_subcall(
 118                 struct afb_xreq *xreq,
 119                 const char *api,
 120                 const char *verb,
 121                 struct json_object *args,
 122                 void (*callback)(void*, int, struct json_object*, struct afb_request *),
 123                 void *cb_closure);
 124 extern void afb_xreq_unhooked_subcall(
 125                 struct afb_xreq *xreq,
 126                 const char *api,
 127                 const char *verb,
 128                 struct json_object *args,
 129                 void (*callback)(void*, int, struct json_object*, struct afb_request *),
 130                 void *cb_closure);
 131
 132 extern int afb_xreq_unhooked_subcall_sync(
 133                 struct afb_xreq *xreq,
 134                 const char *api,
 135                 const char *verb,
 136                 struct json_object *args,
 137                 struct json_object **result);
 138 extern int afb_xreq_subcall_sync(
 139                 struct afb_xreq *xreq,
 140                 const char *api,
 141                 const char *verb,
 142                 struct json_object *args,
 143                 struct json_object **result);
 144
 145 /* initialisation and processing of xreq */
 146 extern void afb_xreq_init(struct afb_xreq *xreq, const struct afb_xreq_query_itf *queryitf);
 147
 148 extern void afb_xreq_process(struct afb_xreq *xreq, struct afb_apiset *apiset);
 149
 150 extern void afb_xreq_call_verb_v1(struct afb_xreq *xreq, const struct afb_verb_desc_v1 *verb);
 151 extern void afb_xreq_call_verb_v2(struct afb_xreq *xreq, const struct afb_verb_v2 *verb);
 152 extern void afb_xreq_call_verb_vdyn(struct afb_xreq *xreq, const struct afb_api_dyn_verb *verb);