src/charon/threads/stroke_interface.h

   1 /**
   2  * @file stroke.h
   3  *
   4  * @brief Interface of stroke_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2006 Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License as published by the
  14  * Free Software Foundation; either version 2 of the License, or (at your
  15  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #ifndef STROKE_INTERFACE_H_
  24 #define STROKE_INTERFACE_H_
  25
  26
  27
  28 typedef struct stroke_t stroke_t;
  29
  30 /**
  31  * @brief Stroke is a configuration and control interface which
  32  * allows other processes to modify charons behavior.
  33  *
  34  * stroke_t allows config manipulation (as whack in pluto).
  35  * Messages of type stroke_msg_t's are sent over a unix socket
  36  * (/var/run/charon.ctl).
  37  *
  38  * @b Constructors:
  39  * - stroke_create()
  40  *
  41  * @ingroup threads
  42  */
  43 struct stroke_t {
  44
  45         /**
  46          * @brief Destroy a stroke_t instance.
  47          *
  48          * @param this          stroke_t objec to destroy
  49          */
  50         void (*destroy) (stroke_t *this);
  51 };
  52
  53
  54 /**
  55  * @brief Create the stroke interface and listen on the socket.
  56  *
  57  * @return stroke_t object
  58  *
  59  * @ingroup threads
  60  */
  61 stroke_t *stroke_create(void);
  62
  63 #endif /* STROKE_INTERFACE_H_ */