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  * Converts the 'event' to an afb_eventid.
  33  */
  34 static inline struct afb_eventid *afb_event_to_eventid(struct afb_event event)
  35 {
  36         return event.closure;
  37 }
  38
  39 /*
  40  * Checks wether the 'event' is valid or not.
  41  *
  42  * Returns 0 if not valid or 1 if valid.
  43  */
  44 static inline int afb_event_is_valid(struct afb_event event)
  45 {
  46         return !!event.itf;
  47 }
  48
  49 /*
  50  * Broadcasts widely the 'event' with the data 'object'.
  51  * 'object' can be NULL.
  52  *
  53  * For convenience, the function calls 'json_object_put' for 'object'.
  54  * Thus, in the case where 'object' should remain available after
  55  * the function returns, the function 'json_object_get' shall be used.
  56  *
  57  * Returns the count of clients that received the event.
  58  */
  59 static inline int afb_event_broadcast(struct afb_event event, struct json_object *object)
  60 {
  61         return event.itf->broadcast(event.closure, object);
  62 }
  63
  64 /*
  65  * Pushes the 'event' with the data 'object' to its observers.
  66  * 'object' can be NULL.
  67  *
  68  * For convenience, the function calls 'json_object_put' for 'object'.
  69  * Thus, in the case where 'object' should remain available after
  70  * the function returns, the function 'json_object_get' shall be used.
  71  *
  72  * Returns the count of clients that received the event.
  73  */
  74 static inline int afb_event_push(struct afb_event event, struct json_object *object)
  75 {
  76         return event.itf->push(event.closure, object);
  77 }
  78
  79 /* OBSOLETE */
  80 #define afb_event_drop afb_event_unref
  81
  82 /*
  83  * Gets the name associated to the 'event'.
  84  */
  85 static inline const char *afb_event_name(struct afb_event event)
  86 {
  87         return event.itf->name(event.closure);
  88 }
  89
  90 /*
  91  * Decreases the count of reference to 'event' and
  92  * destroys the event when the reference count falls to zero.
  93  */
  94 static inline void afb_event_unref(struct afb_event event)
  95 {
  96         event.itf->unref(event.closure);
  97 }
  98
  99 /*
 100  * Increases the count of reference to 'event'
 101  */
 102 static inline void afb_event_addref(struct afb_event event)
 103 {
 104         event.itf->addref(event.closure);
 105 }
 106