src/libcharon/processing/jobs/initiate_tasks_job.h

   1 /*
   2  * Copyright (C) 2015 Martin Willi
   3  *
   4  * Copyright (C) secunet Security Networks AG
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2 of the License, or (at your
   9  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * for more details.
  15  */
  16
  17 /**
  18  * @defgroup initiate_tasks_job initiate_tasks_job
  19  * @{ @ingroup cjobs
  20  */
  21
  22 #ifndef INITIATE_TASKS_JOB_H_
  23 #define INITIATE_TASKS_JOB_H_
  24
  25 typedef struct initiate_tasks_job_t initiate_tasks_job_t;
  26
  27 #include <library.h>
  28 #include <processing/jobs/job.h>
  29 #include <sa/ike_sa_id.h>
  30
  31 /**
  32  * Job triggering initiation of any queued IKE_SA tasks.
  33  */
  34 struct initiate_tasks_job_t {
  35
  36         /**
  37          * Implements job_t interface
  38          */
  39         job_t job_interface;
  40 };
  41
  42 /**
  43  * Creates a job to trigger IKE_SA task initiation.
  44  *
  45  * @param ike_sa_id             ID of IKE_SA to trigger tasks for (gets cloned)
  46  * @return                              job instance
  47  */
  48 initiate_tasks_job_t *initiate_tasks_job_create(ike_sa_id_t *ike_sa_id);
  49
  50 #endif /** INITIATE_TASKS_JOB_H_ @}*/