src/charon/queues/jobs/retransmit_job.h

   1 /**
   2  * @file retransmit_job.h
   3  *
   4  * @brief Interface of retransmit_job_t.
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005-2007 Martin Willi
  10  * Copyright (C) 2005 Jan Hutter
  11  * Hochschule fuer Technik Rapperswil
  12  *
  13  * This program is free software; you can redistribute it and/or modify it
  14  * under the terms of the GNU General Public License as published by the
  15  * Free Software Foundation; either version 2 of the License, or (at your
  16  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  20  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  21  * for more details.
  22  */
  23
  24 #ifndef RETRANSMIT_JOB_H_
  25 #define RETRANSMIT_JOB_H_
  26
  27 typedef struct retransmit_job_t retransmit_job_t;
  28
  29 #include <library.h>
  30 #include <queues/jobs/job.h>
  31 #include <sa/ike_sa_id.h>
  32
  33 /**
  34  * @brief Class representing an retransmit Job.
  35  *
  36  * This job is scheduled every time a request is sent over the
  37  * wire. If the response to the request is not received at schedule
  38  * time, the retransmission will be initiated.
  39  *
  40  * @b Constructors:
  41  * - retransmit_job_create()
  42  *
  43  * @ingroup jobs
  44  */
  45 struct retransmit_job_t {
  46         /**
  47          * The job_t interface.
  48          */
  49         job_t job_interface;
  50 };
  51
  52 /**
  53  * @brief Creates a job of type retransmit.
  54  *
  55  * @param message_id            message_id of the request to resend
  56  * @param ike_sa_id                     identification of the ike_sa as ike_sa_id_t
  57  * @return                                      retransmit_job_t object
  58  *
  59  * @ingroup jobs
  60  */
  61 retransmit_job_t *retransmit_job_create(u_int32_t message_id,
  62                                                                                 ike_sa_id_t *ike_sa_id);
  63
  64 #endif /* RETRANSMIT_JOB_H_ */