Source/charon/sa/states/ike_sa_established.h

   1 /**
   2  * @file ike_sa_established.h
   3  *
   4  * @brief Interface of ike_sa_established_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, 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 IKE_SA_ESTABLISHED_H_
  24 #define IKE_SA_ESTABLISHED_H_
  25
  26 #include <sa/states/state.h>
  27 #include <sa/ike_sa.h>
  28
  29 typedef struct ike_sa_established_t ike_sa_established_t;
  30
  31 /**
  32  * @brief This class represents an the state of an established
  33  * IKE_SA.
  34  *
  35  * @b Constructors:
  36  * - ike_sa_established_create()
  37  *
  38  * @todo Implement handling of CREATE_CHILD_SA requests
  39  *
  40  * @todo Implement initialization of CREATE_CHILD_SA requests
  41  *
  42  * @todo Implement handling of any other message
  43  *
  44  * @ingroup states
  45  */
  46 struct ike_sa_established_t {
  47         /**
  48          * methods of the state_t interface
  49          */
  50         state_t state_interface;
  51
  52 };
  53
  54 /**
  55  * @brief Constructor of class ike_sa_established_t
  56  *
  57  * @param ike_sa        assigned ike_sa
  58  * @return                      created ike_sa_established_t object
  59  *
  60  * @ingroup states
  61  */
  62 ike_sa_established_t *ike_sa_established_create(protected_ike_sa_t *ike_sa);
  63
  64 #endif /*IKE_SA_ESTABLISHED_H_*/