include/afb/afb-event-x1.h

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