src/charon/plugins/stroke/stroke_control.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$
  16  */
  17
  18 /**
  19  * @defgroup stroke_control stroke_control
  20  * @{ @ingroup stroke
  21  */
  22
  23 #ifndef STROKE_CONTROL_H_
  24 #define STROKE_CONTROL_H_
  25
  26 #include <stroke_msg.h>
  27 #include <library.h>
  28 #include <stdio.h>
  29
  30 typedef struct stroke_control_t stroke_control_t;
  31
  32 /**
  33  * Process stroke control messages
  34  */
  35 struct stroke_control_t {
  36
  37         /**
  38          * Initiate a connection.
  39          *
  40          * @param msg           stroke message
  41          */
  42         void (*initiate)(stroke_control_t *this, stroke_msg_t *msg, FILE *out);
  43
  44         /**
  45          * Terminate a connection.
  46          *
  47          * @param msg           stroke message
  48          */
  49         void (*terminate)(stroke_control_t *this, stroke_msg_t *msg, FILE *out);
  50
  51         /**
  52          * Terminate a connection by peers virtual IP.
  53          *
  54          * @param msg           stroke message
  55          */
  56         void (*terminate_srcip)(stroke_control_t *this, stroke_msg_t *msg, FILE *out);
  57
  58         /**
  59          * Route a connection.
  60          *
  61          * @param msg           stroke message
  62          */
  63         void (*route)(stroke_control_t *this, stroke_msg_t *msg, FILE *out);
  64
  65         /**
  66          * Unroute a connection.
  67          *
  68          * @param msg           stroke message
  69          */
  70         void (*unroute)(stroke_control_t *this, stroke_msg_t *msg, FILE *out);
  71
  72         /**
  73      * Destroy a stroke_control instance.
  74      */
  75     void (*destroy)(stroke_control_t *this);
  76 };
  77
  78 /**
  79  * Create a stroke_control instance.
  80  */
  81 stroke_control_t *stroke_control_create();
  82
  83 #endif /** STROKE_CONTROL_H_ @}*/