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 /**
  37  * SECTION:plugin
  38  * @title: Plugin premitives
  39  * @short_description: Functions for declaring plugins
  40  */
  41
  42 struct connman_plugin_desc {
  43         const char *name;
  44         const char *description;
  45         const char *version;
  46         int (*init) (void);
  47         void (*exit) (void);
  48 };
  49
  50 /**
  51  * CONNMAN_PLUGIN_DEFINE:
  52  * @name: plugin name
  53  * @description: plugin description
  54  * @version: plugin version string
  55  * @init: init function called on plugin loading
  56  * @exit: exit function called on plugin removal
  57  *
  58  * Macro for defining a plugin descriptor
  59  *
  60  * |[
  61  * #include <connman/plugin.h>
  62  *
  63  * static int example_init(void)
  64  * {
  65  *      return 0;
  66  * }
  67  *
  68  * static void example_exit(void)
  69  * {
  70  * }
  71  *
  72  * CONNMAN_PLUGIN_DEFINE(example, "Example plugin", CONNMAN_VERSION,
  73  *                                      example_init, example_exit)
  74  * ]|
  75  */
  76 #define CONNMAN_PLUGIN_DEFINE(name, description, version, init, exit) \
  77                 struct connman_plugin_desc connman_plugin_desc = { \
  78                         #name, description, version, init, exit \
  79                 };
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85 #endif /* __CONNMAN_PLUGIN_H */