include/afb/afb-event-itf.h

   1 /*
   2  * Copyright (C) 2016 "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 handling requests.
  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_event_itf {
  30         /* CAUTION: respect the order, add at the end */
  31
  32         int (*broadcast)(void *closure, struct json_object *obj);
  33         int (*push)(void *closure, struct json_object *obj);
  34         void (*drop)(void *closure);
  35 };
  36
  37 /*
  38  * Describes the request of afb-daemon for bindings
  39  */
  40 struct afb_event {
  41         const struct afb_event_itf *itf;        /* the interface to use */
  42         void *closure;                          /* the closure argument for functions of 'itf' */
  43 };
  44
  45 /*
  46  * Checks wether the 'event' is valid or not.
  47  *
  48  * Returns 0 if not valid or 1 if valid.
  49  */
  50 static inline int afb_event_is_valid(struct afb_event event)
  51 {
  52         return event.itf != NULL;
  53 }
  54
  55 /*
  56  * Broadcasts widely the 'event' with the data 'object'.
  57  * 'object' can be NULL.
  58  *
  59  * For convenience, the function calls 'json_object_put' for 'object'.
  60  * Thus, in the case where 'object' should remain available after
  61  * the function returns, the function 'json_object_get' shall be used.
  62  *
  63  * Returns the count of clients that received the event.
  64  */
  65 static inline int afb_event_broadcast(struct afb_event event, struct json_object *object)
  66 {
  67         return event.itf->broadcast(event.closure, object);
  68 }
  69
  70 /*
  71  * Pushes the 'event' with the data 'object' to its observers.
  72  * 'object' can be NULL.
  73  *
  74  * For convenience, the function calls 'json_object_put' for 'object'.
  75  * Thus, in the case where 'object' should remain available after
  76  * the function returns, the function 'json_object_get' shall be used.
  77  *
  78  * Returns the count of clients that received the event.
  79  */
  80 static inline int afb_event_push(struct afb_event event, struct json_object *object)
  81 {
  82         return event.itf->push(event.closure, object);
  83 }
  84
  85 /*
  86  * Drops the data associated to the event
  87  * After calling this function, the event
  88  * MUST NOT BE USED ANYMORE.
  89  */
  90 static inline void afb_event_drop(struct afb_event event)
  91 {
  92         event.itf->drop(event.closure);
  93 }
  94