include/plugin.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2009  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef __CONNMAN_PLUGIN_H
  23 #define __CONNMAN_PLUGIN_H
  24
  25 #include <connman/version.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #ifndef CONNMAN_API_SUBJECT_TO_CHANGE
  32 #error "Please define CONNMAN_API_SUBJECT_TO_CHANGE to acknowledge your \
  33 understanding that ConnMan hasn't reached a stable API."
  34 #endif
  35
  36 #define CONNMAN_PLUGIN_PRIORITY_LOW      -100
  37 #define CONNMAN_PLUGIN_PRIORITY_DEFAULT     0
  38 #define CONNMAN_PLUGIN_PRIORITY_HIGH      100
  39
  40 /**
  41  * SECTION:plugin
  42  * @title: Plugin premitives
  43  * @short_description: Functions for declaring plugins
  44  */
  45
  46 struct connman_plugin_desc {
  47         const char *name;
  48         const char *description;
  49         const char *version;
  50         int priority;
  51         int (*init) (void);
  52         void (*exit) (void);
  53 };
  54
  55 /**
  56  * CONNMAN_PLUGIN_DEFINE:
  57  * @name: plugin name
  58  * @description: plugin description
  59  * @version: plugin version string
  60  * @init: init function called on plugin loading
  61  * @exit: exit function called on plugin removal
  62  *
  63  * Macro for defining a plugin descriptor
  64  *
  65  * |[
  66  * #include <connman/plugin.h>
  67  *
  68  * static int example_init(void)
  69  * {
  70  *      return 0;
  71  * }
  72  *
  73  * static void example_exit(void)
  74  * {
  75  * }
  76  *
  77  * CONNMAN_PLUGIN_DEFINE(example, "Example plugin", CONNMAN_VERSION,
  78  *                                      example_init, example_exit)
  79  * ]|
  80  */
  81 #ifdef CONNMAN_PLUGIN_BUILTIN
  82 #define CONNMAN_PLUGIN_DEFINE(name, description, version, priority, init, exit) \
  83                 struct connman_plugin_desc __connman_builtin_ ## name = { \
  84                         #name, description, version, priority, init, exit \
  85                 };
  86 #else
  87 #define CONNMAN_PLUGIN_DEFINE(name, description, version, priority, init, exit) \
  88                 extern struct connman_plugin_desc connman_plugin_desc \
  89                                 __attribute__ ((visibility("default"))); \
  90                 struct connman_plugin_desc connman_plugin_desc = { \
  91                         #name, description, version, priority, init, exit \
  92                 };
  93 #endif
  94
  95 #ifdef __cplusplus
  96 }
  97 #endif
  98
  99 #endif /* __CONNMAN_PLUGIN_H */