src/charon/queues/jobs/rekey_ike_sa_job.h

   1 /**
   2  * @file rekey_ike_sa_job.h
   3  *
   4  * @brief Interface of rekey_ike_sa_job_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2006 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 REKEY_IKE_SA_JOB_H_
  24 #define REKEY_IKE_SA_JOB_H_
  25
  26 typedef struct rekey_ike_sa_job_t rekey_ike_sa_job_t;
  27
  28 #include <library.h>
  29 #include <sa/ike_sa_id.h>
  30 #include <queues/jobs/job.h>
  31
  32 /**
  33  * @brief Class representing an REKEY_IKE_SA Job.
  34  *
  35  * This job initiates the rekeying of an IKE_SA.
  36  *
  37  * @b Constructors:
  38  *  - rekey_ike_sa_job_create()
  39  *
  40  * @ingroup jobs
  41  */
  42 struct rekey_ike_sa_job_t {
  43         /**
  44          * The job_t interface.
  45          */
  46         job_t job_interface;
  47 };
  48
  49 /**
  50  * @brief Creates a job of type REKEY_IKE_SA.
  51  *
  52  * @param ike_sa_id             ID of the IKE_SA to rekey
  53  * @param reauth                TRUE to reauthenticate peer, FALSE for rekeying only
  54  * @return                              rekey_ike_sa_job_t object
  55  *
  56  * @ingroup jobs
  57  */
  58 rekey_ike_sa_job_t *rekey_ike_sa_job_create(ike_sa_id_t *ike_sa_id, bool reauth);
  59
  60 #endif /* REKEY_IKE_SA_JOB_H_ */