src/libcharon/sa/tasks/ike_dpd.h

   1 /*
   2  * Copyright (C) 2007 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
  16 /**
  17  * @defgroup ike_dpd ike_dpd
  18  * @{ @ingroup tasks
  19  */
  20
  21 #ifndef IKE_DPD_H_
  22 #define IKE_DPD_H_
  23
  24 typedef struct ike_dpd_t ike_dpd_t;
  25
  26 #include <library.h>
  27 #include <sa/ike_sa.h>
  28 #include <sa/tasks/task.h>
  29
  30 /**
  31  * Task of type ike_dpd, detects dead peers.
  32  *
  33  * The DPD task actually does nothing, as a DPD has no associated payloads.
  34  */
  35 struct ike_dpd_t {
  36
  37         /**
  38          * Implements the task_t interface
  39          */
  40         task_t task;
  41 };
  42
  43 /**
  44  * Create a new ike_dpd task.
  45  *
  46  * @param initiator             TRUE if thask is the original initiator
  47  * @return                              ike_dpd task to handle by the task_manager
  48  */
  49 ike_dpd_t *ike_dpd_create(bool initiator);
  50
  51 #endif /** IKE_DPD_H_ @}*/