updated Doxyfile
[strongswan.git] / src / charon / processing / jobs / retransmit_job.h
1 /*
2 * Copyright (C) 2005-2007 Martin Willi
3 * Copyright (C) 2005 Jan Hutter
4 * Hochschule fuer Technik Rapperswil
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 * $Id$
17 */
18
19 /**
20 * @defgroup retransmit_job retransmit_job
21 * @{ @ingroup jobs
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 <processing/jobs/job.h>
31 #include <sa/ike_sa_id.h>
32
33 /**
34 * 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 struct retransmit_job_t {
41 /**
42 * The job_t interface.
43 */
44 job_t job_interface;
45 };
46
47 /**
48 * Creates a job of type retransmit.
49 *
50 * @param message_id message_id of the request to resend
51 * @param ike_sa_id identification of the ike_sa as ike_sa_id_t
52 * @return retransmit_job_t object
53 */
54 retransmit_job_t *retransmit_job_create(u_int32_t message_id,
55 ike_sa_id_t *ike_sa_id);
56
57 #endif /** RETRANSMIT_JOB_H_ @}*/