include/afb/afb-service-itf-v1.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_service;
  22
  23 /*
  24  * When a binding have an exported implementation of the
  25  * function 'afbBindingV1ServiceInit', defined below,
  26  * the framework calls it for initialising the service after
  27  * registration of all bindings.
  28  *
  29  * The object 'service' should be recorded. It has functions that
  30  * allows the binding to call features with its own personality.
  31  *
  32  * The function should return 0 in case of success or, else, should return
  33  * a negative value.
  34  */
  35 extern int afbBindingV1ServiceInit(struct afb_service service);
  36
  37 /*
  38  * When a binding have an implementation of the function 'afbBindingV1ServiceEvent',
  39  * defined below, the framework calls that function for any broadcasted event or for
  40  * events that the service subscribed to in its name.
  41  *
  42  * It receive the 'event' name and its related data in 'object' (be aware that 'object'
  43  * might be NULL).
  44  */
  45 extern void afbBindingV1ServiceEvent(const char *event, struct json_object *object);
  46
  47