zigbee-daemon/zigbee-lib/include/zblib_plugin.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved.
   3  *
   4  * Contact: Suresh Kumar N (suresh.n@samsung.com)
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 #ifndef __ZIGBEE_LIB_PLUGIN_H__
  20 #define __ZIGBEE_LIB_PLUGIN_H__
  21
  22 /**< ZigBee plug-in asynchronous initializer callback */
  23 typedef void (*zblib_plugin_init_finished_cb)(gboolean result, void *user_data);
  24
  25 /**< ZigBee plug-in descriptor */
  26 typedef struct {
  27         const gchar *name;
  28         int version;
  29         gboolean (*load)(); /**< Load plugin */
  30         gboolean (*init)(ZigBeePlugin *); /**< Initialize plugin */
  31         gboolean (*init_async)(ZigBeePlugin *, zblib_plugin_init_finished_cb, void *);
  32                         /**< Initialize plugin asynchronously */
  33         void (*unload)(ZigBeePlugin *); /**< Unload plugin */
  34 } ZblibPluginDescriptor_t;
  35
  36 /* ZigBee vendor plug-in APIs */
  37 ZigBeePlugin *zblib_plugin_new(ZigBeeService *service,
  38         const gchar *plugin_name,
  39         const ZblibPluginDescriptor_t *descriptor,
  40         void *plugin_handle);
  41 void zblib_plugin_free(ZigBeePlugin *plugin);
  42
  43 const ZblibPluginDescriptor_t *zblib_plugin_get_descriptor(ZigBeePlugin *plugin);
  44 char *zblib_plugin_get_plugin_name(ZigBeePlugin *plugin);
  45
  46 ZigBeeService *zblib_plugin_ref_service(ZigBeePlugin *plugin);
  47
  48 ZigBeeDriver *zblib_plugin_ref_driver(ZigBeePlugin *plugin, ZblibDriverType_e driver_type);
  49 void zblib_plugin_link_driver(ZigBeePlugin *plugin, ZigBeeDriver *driver);
  50 void zblib_plugin_unlink_driver(ZigBeePlugin *plugin, ZblibDriverType_e driver_type);
  51
  52 gboolean zblib_plugin_dispatch_request(ZigBeePlugin *plugin,
  53         guint request_id);
  54 void zblib_plugin_send_response(ZigBeePlugin *plugin,
  55         guint request_id, gpointer resp_data, guint resp_data_len);
  56
  57 void zblib_plugin_send_notification(ZigBeePlugin *plugin,
  58         guint noti_id, gpointer noti_data, guint noti_data_len);
  59
  60 #endif /* __ZIGBEE_LIB_PLUGIN_H__ */