include/plugin.h

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2007-2008  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 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /**
  30  * SECTION:plugin
  31  * @title: Plugin premitives
  32  * @short_description: Functions for declaring plugins
  33  */
  34
  35 struct connman_plugin_desc {
  36         const char *name;
  37         const char *description;
  38         const char *version;
  39         int (*init) (void);
  40         void (*exit) (void);
  41 };
  42
  43 /**
  44  * CONNMAN_PLUGIN_DEFINE:
  45  * @name: plugin name
  46  * @description: plugin description
  47  * @version: plugin version string
  48  * @init: init function called on plugin loading
  49  * @exit: exit function called on plugin removal
  50  *
  51  * Macro for defining a plugin descriptor
  52  */
  53 #define CONNMAN_PLUGIN_DEFINE(name, description, version, init, exit) \
  54                 struct connman_plugin_desc connman_plugin_desc = { \
  55                         name, description, version, init, exit \
  56                 };
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif /* __CONNMAN_PLUGIN_H */