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