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