e3bb9f9e4fde2a080f702746c5b7a8b768bdd1a8
[strongswan.git] / src / charon / processing / jobs / send_keepalive_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_keepalive_job send_keepalive_job
20 * @{ @ingroup jobs
21 */
22
23 #ifndef SEND_KEEPALIVE_JOB_H_
24 #define SEND_KEEPALIVE_JOB_H_
25
26 typedef struct send_keepalive_job_t send_keepalive_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_KEEPALIVE Job.
34 *
35 * This job will send a NAT keepalive packet if the IKE SA is still alive,
36 * and reinsert itself into the event queue.
37 */
38 struct send_keepalive_job_t {
39 /**
40 * implements job_t interface
41 */
42 job_t job_interface;
43 };
44
45 /**
46 * Creates a job of type SEND_KEEPALIVE.
47 *
48 * @param ike_sa_id identification of the ike_sa as ike_sa_id_t object (gets cloned)
49 * @return initiate_ike_sa_job_t object
50 */
51 send_keepalive_job_t *send_keepalive_job_create(ike_sa_id_t *ike_sa_id);
52
53 #endif /*SEND_KEEPALIVE_JOB_H_ @} */