src/charon/processing/jobs/initiate_job.h

   1 /**
   2  * @file initiate_job.h
   3  *
   4  * @brief Interface of initiate_job_t.
   5  */
   6
   7 /*
   8  * Copyright (C) 2005-2007 Martin Willi
   9  * Copyright (C) 2005 Jan Hutter
  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 INITIATE_JOB_H_
  24 #define INITIATE_JOB_H_
  25
  26 typedef struct initiate_job_t initiate_job_t;
  27
  28 #include <library.h>
  29 #include <processing/jobs/job.h>
  30 #include <config/peer_cfg.h>
  31 #include <config/child_cfg.h>
  32
  33 /**
  34  * @brief Class representing an INITIATE_IKE_SA Job.
  35  *
  36  * This job is created if an IKE_SA should be iniated.
  37  *
  38  * @b Constructors:
  39  * - initiate_job_create()
  40  *
  41  * @ingroup jobs
  42  */
  43 struct initiate_job_t {
  44         /**
  45          * implements job_t interface
  46          */
  47         job_t job_interface;
  48 };
  49
  50 /**
  51  * @brief Creates a job of type INITIATE.
  52  *
  53  * @param peer_cfg              peer configuration to use (if not yet established)
  54  * @param child_cfg             config to create a CHILD from
  55  * @return                              initiate_job_t object
  56  *
  57  * @ingroup jobs
  58  */
  59 initiate_job_t *initiate_job_create(peer_cfg_t *peer_cfg, child_cfg_t *child_cfg);
  60
  61 #endif /*INITIATE_JOB_H_*/