src/charon/processing/jobs/acquire_job.h

   1 /*
   2  * Copyright (C) 2006 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  * $Id$
  16  */
  17
  18 /**
  19  * @defgroup acquire_job acquire_job
  20  * @{ @ingroup jobs
  21  */
  22
  23 #ifndef ACQUIRE_JOB_H_
  24 #define ACQUIRE_JOB_H_
  25
  26 typedef struct acquire_job_t acquire_job_t;
  27
  28 #include <library.h>
  29 #include <processing/jobs/job.h>
  30
  31 /**
  32  * Class representing an ACQUIRE Job.
  33  *
  34  * This job initiates a CHILD SA on kernel request.
  35  */
  36 struct acquire_job_t {
  37         /**
  38          * The job_t interface.
  39          */
  40         job_t job_interface;
  41 };
  42
  43 /**
  44  * Creates a job of type ACQUIRE.
  45  *
  46  * We use the reqid to find the routed CHILD_SA.
  47  *
  48  * @param reqid         reqid of the CHILD_SA to acquire
  49  * @return                      acquire_job_t object
  50  */
  51 acquire_job_t *acquire_job_create(u_int32_t reqid);
  52
  53 #endif /* REKEY_CHILD_SA_JOB_H_ @} */