updated Doxyfile
[strongswan.git] / src / charon / processing / jobs / send_dpd_job.h
1 /*
2 * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
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 send_dpd_job send_dpd_job
20 * @{ @ingroup jobs
21 */
22
23 #ifndef SEND_DPD_JOB_H_
24 #define SEND_DPD_JOB_H_
25
26 typedef struct send_dpd_job_t send_dpd_job_t;
27
28 #include <library.h>
29 #include <processing/jobs/job.h>
30 #include <sa/ike_sa_id.h>
31
32 /**
33 * Class representing a SEND_DPD Job.
34 *
35 * Job to periodically send a Dead Peer Detection (DPD) request,
36 * ie. an IKE request with no payloads other than the encrypted payload
37 * required by the syntax.
38 */
39 struct send_dpd_job_t {
40 /**
41 * implements job_t interface
42 */
43 job_t job_interface;
44 };
45
46 /**
47 * Creates a job of type SEND_DPD.
48 *
49 * @param ike_sa_id identification of the ike_sa as ike_sa_id_t object (gets cloned)
50 * @return initiate_ike_sa_job_t object
51 */
52 send_dpd_job_t *send_dpd_job_create(ike_sa_id_t *ike_sa_id);
53
54 #endif /** SEND_DPD_JOB_H_ @}*/