include/afb/afb-event-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 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 {
  31         /* CAUTION: respect the order, add at the end */
  32
  33         int (*broadcast)(void *closure, struct json_object *obj);
  34         int (*push)(void *closure, struct json_object *obj);
  35         void (*unref)(void *closure);
  36         const char *(*name)(void *closure);
  37         void (*addref)(void *closure);
  38 };
  39
  40 /*
  41  * Describes the request of afb-daemon for bindings
  42  */
  43 struct afb_event
  44 {
  45         const struct afb_event_itf *itf;        /* the interface to use */
  46         void *closure;                          /* the closure argument for functions of 'itf' */
  47 };
  48
  49 /*
  50  * Checks wether the 'event' is valid or not.
  51  *
  52  * Returns 0 if not valid or 1 if valid.
  53  */
  54 static inline int afb_event_is_valid(struct afb_event event)
  55 {
  56         return !!event.itf;
  57 }
  58
  59 /*
  60  * Broadcasts widely the 'event' with the data 'object'.
  61  * 'object' can be NULL.
  62  *
  63  * For convenience, the function calls 'json_object_put' for 'object'.
  64  * Thus, in the case where 'object' should remain available after
  65  * the function returns, the function 'json_object_get' shall be used.
  66  *
  67  * Returns the count of clients that received the event.
  68  */
  69 static inline int afb_event_broadcast(struct afb_event event, struct json_object *object)
  70 {
  71         return event.itf->broadcast(event.closure, object);
  72 }
  73
  74 /*
  75  * Pushes the 'event' with the data 'object' to its observers.
  76  * 'object' can be NULL.
  77  *
  78  * For convenience, the function calls 'json_object_put' for 'object'.
  79  * Thus, in the case where 'object' should remain available after
  80  * the function returns, the function 'json_object_get' shall be used.
  81  *
  82  * Returns the count of clients that received the event.
  83  */
  84 static inline int afb_event_push(struct afb_event event, struct json_object *object)
  85 {
  86         return event.itf->push(event.closure, object);
  87 }
  88
  89 /* OBSOLETE */
  90 #define afb_event_drop afb_event_unref
  91
  92 /*
  93  * Gets the name associated to the 'event'.
  94  */
  95 static inline const char *afb_event_name(struct afb_event event)
  96 {
  97         return event.itf->name(event.closure);
  98 }
  99
 100 /*
 101  * Decrease the count of reference to 'event' and
 102  * destroys the event when the reference count falls to zero.
 103  */
 104 static inline void afb_event_unref(struct afb_event event)
 105 {
 106         event.itf->unref(event.closure);
 107 }
 108
 109 /*
 110  * remove one reference to the data associated to the 'event'
 111  * After calling this function, the event
 112  * MUST NOT BE USED ANYMORE.
 113  */
 114 static inline void afb_event_addref(struct afb_event event)
 115 {
 116         event.itf->addref(event.closure);
 117 }
 118