include/afb/afb-service-itf.h

   1 /*
   2  * Copyright (C) 2016, 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 /* avoid inclusion of <json-c/json.h> */
  21 struct json_object;
  22
  23 /*
  24  * Interface for internal of services
  25  * It records the functions to be called for the request.
  26  * Don't use this structure directly.
  27  * Use the helper functions documented below.
  28  */
  29 struct afb_service_itf
  30 {
  31         /* CAUTION: respect the order, add at the end */
  32
  33         void (*call)(void *closure, const char *api, const char *verb, struct json_object *args, void (*callback)(void*, int, struct json_object*), void *callback_closure);
  34 };
  35
  36 /*
  37  * Object that encapsulate accesses to service items
  38  */
  39 struct afb_service
  40 {
  41         const struct afb_service_itf *itf;
  42         void *closure;
  43 };
  44
  45 /*
  46  * When a binding have an exported implementation of the
  47  * function 'afbBindingV1ServiceInit', defined below,
  48  * the framework calls it for initialising the service after
  49  * registration of all bindings.
  50  *
  51  * The object 'service' should be recorded. It has functions that
  52  * allows the binding to call features with its own personality.
  53  *
  54  * The function should return 0 in case of success or, else, should return
  55  * a negative value.
  56  */
  57 extern int afbBindingV1ServiceInit(struct afb_service service);
  58
  59 /*
  60  * When a binding have an implementation of the function 'afbBindingV1ServiceEvent',
  61  * defined below, the framework calls that function for any broadcasted event or for
  62  * events that the service subscribed to in its name.
  63  *
  64  * It receive the 'event' name and its related data in 'object' (be aware that 'object'
  65  * might be NULL).
  66  */
  67 extern void afbBindingV1ServiceEvent(const char *event, struct json_object *object);
  68
  69 /*
  70  * Calls the 'verb' of the 'api' with the arguments 'args' and 'verb' in the name of the binding.
  71  * The result of the call is delivered to the 'callback' function with the 'callback_closure'.
  72  *
  73  * The 'callcack' receives 3 arguments:
  74  *  1. 'closure' the user defined closure pointer 'callback_closure',
  75  *  2. 'iserror' a boolean status being true (not null) when an error occured,
  76  *  2. 'result' the resulting data as a JSON object.
  77  *
  78  * See also 'afb_req_subcall'
  79  *
  80  * Returns 0in case of success or -1 in case of error.
  81  */
  82 static inline void afb_service_call(struct afb_service service, const char *api, const char *verb, struct json_object *args, void (*callback)(void*closure, int iserror, struct json_object *result), void *callback_closure)
  83 {
  84         service.itf->call(service.closure, api, verb, args, callback, callback_closure);
  85 }
  86