include/afb/afb-event-x2-itf.h

   1 /*
   2  * Copyright (C) 2015-2020 "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 struct afb_event_x2;
  21 struct afb_event_x2_itf;
  22
  23 /** @addtogroup AFB_EVENT
  24  *  @{ */
  25
  26 /**
  27  * Interface for handling event_x2.
  28  *
  29  * It records the functions to be called for the event_x2.
  30  *
  31  * Don't use this structure directly.
  32  */
  33 struct afb_event_x2_itf
  34 {
  35         /* CAUTION: respect the order, add at the end */
  36
  37         /** broadcast the event */
  38         int (*broadcast)(struct afb_event_x2 *event, struct json_object *obj);
  39
  40         /** push the event to its subscribers */
  41         int (*push)(struct afb_event_x2 *event, struct json_object *obj);
  42
  43         /** unreference the event */
  44         void (*unref)(struct afb_event_x2 *event); /* aka drop */
  45
  46         /** get the event name */
  47         const char *(*name)(struct afb_event_x2 *event);
  48
  49         /** rereference the event */
  50         struct afb_event_x2 *(*addref)(struct afb_event_x2 *event);
  51 };
  52
  53 /**
  54  * Describes the event_x2
  55  */
  56 struct afb_event_x2
  57 {
  58         const struct afb_event_x2_itf *itf;     /**< the interface functions to use */
  59 };
  60
  61 /** @} */