include/afb/afb-event-x1.h

   1 /*
   2  * Copyright (C) 2016-2019 "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-event-x1-itf.h"
  21
  22 /** @addtogroup AFB_EVENT
  23  *  @{ */
  24
  25 /**
  26  * @deprecated use bindings version 3
  27  *
  28  * Converts the 'event' to an afb_eventid.
  29  */
  30 static inline struct afb_event_x2 *afb_event_x1_to_event_x2(struct afb_event_x1 event)
  31 {
  32         return event.closure;
  33 }
  34
  35 /**
  36  * @deprecated use bindings version 3
  37  *
  38  * Checks wether the 'event' is valid or not.
  39  *
  40  * Returns 0 if not valid or 1 if valid.
  41  */
  42 static inline int afb_event_x1_is_valid(struct afb_event_x1 event)
  43 {
  44         return !!event.itf;
  45 }
  46
  47 /**
  48  * @deprecated use bindings version 3
  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_x1_broadcast(struct afb_event_x1 event, struct json_object *object)
  60 {
  61         return event.itf->broadcast(event.closure, object);
  62 }
  63
  64 /**
  65  * @deprecated use bindings version 3
  66  *
  67  * Pushes the 'event' with the data 'object' to its observers.
  68  * 'object' can be NULL.
  69  *
  70  * For convenience, the function calls 'json_object_put' for 'object'.
  71  * Thus, in the case where 'object' should remain available after
  72  * the function returns, the function 'json_object_get' shall be used.
  73  *
  74  * Returns the count of clients that received the event.
  75  */
  76 static inline int afb_event_x1_push(struct afb_event_x1 event, struct json_object *object)
  77 {
  78         return event.itf->push(event.closure, object);
  79 }
  80
  81 /* OBSOLETE */
  82 #define afb_event_x1_drop afb_event_x1_unref
  83
  84 /**
  85  * @deprecated use bindings version 3
  86  *
  87  * Gets the name associated to the 'event'.
  88  */
  89 static inline const char *afb_event_x1_name(struct afb_event_x1 event)
  90 {
  91         return event.itf->name(event.closure);
  92 }
  93
  94 /**
  95  * @deprecated use bindings version 3
  96  *
  97  * Decreases the count of reference to 'event' and
  98  * destroys the event when the reference count falls to zero.
  99  */
 100 static inline void afb_event_x1_unref(struct afb_event_x1 event)
 101 {
 102         event.itf->unref(event.closure);
 103 }
 104
 105 /**
 106  * @deprecated use bindings version 3
 107  *
 108  * Increases the count of reference to 'event'
 109  */
 110 static inline void afb_event_x1_addref(struct afb_event_x1 event)
 111 {
 112         event.itf->addref(event.closure);
 113 }
 114
 115 /** @} */