src/libcharon/sa/tasks/quick_delete.h

   1 /*
   2  * Copyright (C) 2011 Martin Willi
   3  * Copyright (C) 2011 revosec AG
   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 quick_delete quick_delete
  18  * @{ @ingroup tasks
  19  */
  20
  21 #ifndef QUICK_DELETE_H_
  22 #define QUICK_DELETE_H_
  23
  24 typedef struct quick_delete_t quick_delete_t;
  25
  26 #include <library.h>
  27 #include <sa/ike_sa.h>
  28 #include <sa/tasks/task.h>
  29 #include <sa/child_sa.h>
  30
  31 /**
  32  * Task of type QUICK_DELETE, delete an IKEv1 quick mode SA.
  33  */
  34 struct quick_delete_t {
  35
  36         /**
  37          * Implements the task_t interface
  38          */
  39         task_t task;
  40 };
  41
  42 /**
  43  * Create a new quick_delete task.
  44  *
  45  * @param ike_sa                IKE_SA this task works for
  46  * @param protocol              protocol of CHILD_SA to delete, PROTO_NONE as responder
  47  * @param spi                   inbound SPI of CHILD_SA to delete
  48  * @return                              quick_delete task to handle by the task_manager
  49  */
  50 quick_delete_t *quick_delete_create(ike_sa_t *ike_sa, protocol_id_t protocol,
  51                                                                         u_int32_t spi);
  52
  53 #endif /** QUICK_DELETE_H_ @}*/