Source/charon/queues/jobs/initiate_ike_sa_job.h

   1 /**
   2  * @file initiate_ike_sa_job.h
   3  *
   4  * @brief Job of type INITIATE_IKE_SA
   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 INITIATE_IKE_SA_JOB_H_
  24 #define INITIATE_IKE_SA_JOB_H_
  25
  26 #include <types.h>
  27 #include <queues/jobs/job.h>
  28
  29 typedef struct initiate_ike_sa_job_t initiate_ike_sa_job_t;
  30
  31 /**
  32  * Object representing an INITIATE_IKE_SA Job
  33  *
  34  */
  35 struct initiate_ike_sa_job_t {
  36         /**
  37          * implements job_t interface
  38          */
  39         job_t job_interface;
  40
  41         /**
  42          * @brief Returns the currently set configuration name for this job
  43          *
  44          * @warning Returned name is not copied.
  45          *
  46          * @param this  calling initiate_ike_sa_job_t object
  47          * @return              name of the configuration
  48          */
  49         char * (*get_configuration_name) (initiate_ike_sa_job_t *this);
  50
  51         /**
  52          * @brief Destroys an initiate_ike_sa_job_t object.
  53          *
  54          * @param this  initiate_ike_sa_job_t object to destroy
  55          * @return
  56          *                              SUCCESS in any case
  57          */
  58         status_t (*destroy) (initiate_ike_sa_job_t *this);
  59 };
  60
  61 /**
  62  * Creates a job of type INITIATE_IKE_SA
  63  *
  64  * @param configuration_name            name of the configuration to initiate IKE_SA with
  65  * @return
  66  *                              - initiate_ike_sa_job_t if successfully
  67  *                              - NULL if out of ressources or no configuration_name given
  68  */
  69 initiate_ike_sa_job_t *initiate_ike_sa_job_create(char *configuration_name);
  70
  71 #endif /*INITIATE_IKE_SA_JOB_H_*/