include/afb/afb-eventid-itf.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 struct json_object;
  21 struct afb_eventid;
  22 struct afb_eventid_itf;
  23
  24 /*
  25  * Interface for handling requests.
  26  * It records the functions to be called for the request.
  27  * Don't use this structure directly.
  28  * Use the helper functions documented below.
  29  */
  30 struct afb_eventid_itf
  31 {
  32         /* CAUTION: respect the order, add at the end */
  33
  34         int (*broadcast)(struct afb_eventid *eventid, struct json_object *obj);
  35         int (*push)(struct afb_eventid *eventid, struct json_object *obj);
  36         void (*unref)(struct afb_eventid *eventid); /* aka drop */
  37         const char *(*name)(struct afb_eventid *eventid);
  38         struct afb_eventid *(*addref)(struct afb_eventid *eventid);
  39 };
  40
  41 /*
  42  * Describes the request of afb-daemon for bindings
  43  */
  44 struct afb_eventid
  45 {
  46         const struct afb_eventid_itf *itf;      /* the interface to use */
  47 };
  48