Source/charon/queues/jobs/delete_half_open_ike_sa_job.h

   1 /**
   2  * @file delete_half_open_ike_sa_job.h
   3  *
   4  * @brief Interface of delete_half_open_ike_sa_job_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 DELETE_HALF_OPEN_IKE_SA_JOB_H_
  24 #define DELETE_HALF_OPEN_IKE_SA_JOB_H_
  25
  26 #include <types.h>
  27 #include <sa/ike_sa_id.h>
  28 #include <queues/jobs/job.h>
  29
  30
  31 typedef struct delete_half_open_ike_sa_job_t delete_half_open_ike_sa_job_t;
  32
  33 /**
  34  * @brief Class representing an DELETE_HALF_OPEN_IKE_SA Job.
  35  *
  36  * This job is responsible for deleting of half open IKE_SAs. A half
  37  * open IKE_SA is every IKE_SA which hasn't reache the ike_sa_established
  38  * state.
  39  *
  40  * @b Constructors:
  41  *  - delete_half_open_ike_sa_job_create()
  42  *
  43  * @ingroup jobs
  44  */
  45 struct delete_half_open_ike_sa_job_t {
  46         /**
  47          * The job_t interface.
  48          */
  49         job_t job_interface;
  50
  51         /**
  52          * @brief Returns the currently set ike_sa_id.
  53          *
  54          * @warning Returned object is not copied.
  55          *
  56          * @param this  calling delete_half_open_ike_sa_job_t object
  57          * @return              ike_sa_id_t object
  58          */
  59         ike_sa_id_t * (*get_ike_sa_id) (delete_half_open_ike_sa_job_t *this);
  60
  61         /**
  62          * @brief Destroys an delete_half_open_ike_sa_job_t object (including assigned data).
  63          *
  64          * @param this  delete_half_open_ike_sa_job_t object to destroy
  65          */
  66         void (*destroy) (delete_half_open_ike_sa_job_t *this);
  67 };
  68
  69 /**
  70  * @brief Creates a job of type DELETE_HALF_OPEN_IKE_SA.
  71  *
  72  * @param ike_sa_id             id of the IKE_SA to delete
  73  * @return                              created delete_half_open_ike_sa_job_t object
  74  *
  75  * @ingroup jobs
  76  */
  77 delete_half_open_ike_sa_job_t *delete_half_open_ike_sa_job_create(ike_sa_id_t *ike_sa_id);
  78
  79 #endif /*DELETE_HALF_OPEN_IKE_SA_JOB_H_*/