include/afb/afb-event.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 #include "afb-eventid-itf.h"
  21
  22 /*
  23  * Describes the request of afb-daemon for bindings
  24  */
  25 struct afb_event
  26 {
  27         const struct afb_eventid_itf *itf;      /* the interface to use */
  28         struct afb_eventid *closure;            /* the closure argument for functions of 'itf' */
  29 };
  30
  31 /*
  32  * Checks wether the 'event' is valid or not.
  33  *
  34  * Returns 0 if not valid or 1 if valid.
  35  */
  36 static inline int afb_event_is_valid(struct afb_event event)
  37 {
  38         return !!event.itf;
  39 }
  40
  41 /*
  42  * Broadcasts widely the 'event' with the data 'object'.
  43  * 'object' can be NULL.
  44  *
  45  * For convenience, the function calls 'json_object_put' for 'object'.
  46  * Thus, in the case where 'object' should remain available after
  47  * the function returns, the function 'json_object_get' shall be used.
  48  *
  49  * Returns the count of clients that received the event.
  50  */
  51 static inline int afb_event_broadcast(struct afb_event event, struct json_object *object)
  52 {
  53         return event.itf->broadcast(event.closure, object);
  54 }
  55
  56 /*
  57  * Pushes the 'event' with the data 'object' to its observers.
  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_push(struct afb_event event, struct json_object *object)
  67 {
  68         return event.itf->push(event.closure, object);
  69 }
  70
  71 /* OBSOLETE */
  72 #define afb_event_drop afb_event_unref
  73
  74 /*
  75  * Gets the name associated to the 'event'.
  76  */
  77 static inline const char *afb_event_name(struct afb_event event)
  78 {
  79         return event.itf->name(event.closure);
  80 }
  81
  82 /*
  83  * Decreases the count of reference to 'event' and
  84  * destroys the event when the reference count falls to zero.
  85  */
  86 static inline void afb_event_unref(struct afb_event event)
  87 {
  88         event.itf->unref(event.closure);
  89 }
  90
  91 /*
  92  * Increases the count of reference to 'event'
  93  */
  94 static inline void afb_event_addref(struct afb_event event)
  95 {
  96         event.itf->addref(event.closure);
  97 }
  98