src/charon/plugins/stroke/stroke_plugin.h

   1 /*
   2  * Copyright (C) 2008 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  *
  15  * $Id: stroke.h 3589 2008-03-13 14:14:44Z martin $
  16  */
  17
  18 /**
  19  * @defgroup stroke stroke
  20  * @ingroup cplugins
  21  *
  22  * @defgroup stroke_plugin stroke_plugin
  23  * @{ @ingroup stroke
  24  */
  25
  26 #ifndef STROKE_PLUGIN_H_
  27 #define STROKE_PLUGIN_H_
  28
  29 #include <plugins/plugin.h>
  30
  31 typedef struct stroke_plugin_t stroke_plugin_t;
  32
  33 /**
  34  * strongSwan 2.x style configuration and control interface.
  35  *
  36  * Stroke is a home-brewed communication interface inspired by whack. It
  37  * uses a unix socket (/var/run/charon.ctl).
  38  */
  39 struct stroke_plugin_t {
  40
  41         /**
  42          * implements plugin interface
  43          */
  44         plugin_t plugin;
  45 };
  46
  47 /**
  48  * Instanciate stroke plugin.
  49  */
  50 plugin_t *plugin_create();
  51
  52 #endif /* STROKE_PLUGIN_H_ @}*/