updated Doxyfile
[strongswan.git] / src / charon / sa / tasks / ike_mobike.h
1 /*
2 * Copyright (C) 2007 Martin Willi
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 ike_mobike ike_mobike
20 * @{ @ingroup tasks
21 */
22
23 #ifndef IKE_MOBIKE_H_
24 #define IKE_MOBIKE_H_
25
26 typedef struct ike_mobike_t ike_mobike_t;
27
28 #include <library.h>
29 #include <sa/ike_sa.h>
30 #include <sa/tasks/task.h>
31 #include <network/packet.h>
32
33 /**
34 * Task of type ike_mobike, detects and handles MOBIKE extension.
35 *
36 * The MOBIKE extension is defined in RFC4555. It allows to update IKE
37 * and IPsec tunnel addresses.
38 * This tasks handles the MOBIKE_SUPPORTED notify exchange to detect MOBIKE
39 * support, allows the exchange of ADDITIONAL_*_ADDRESS to exchange additional
40 * endpoints and handles the UPDATE_SA_ADDRESS notify to finally update
41 * endpoints.
42 */
43 struct ike_mobike_t {
44
45 /**
46 * Implements the task_t interface
47 */
48 task_t task;
49
50 /**
51 * Use the task to roam to other addresses.
52 *
53 * @param address TRUE to include address list update
54 */
55 void (*roam)(ike_mobike_t *this, bool address);
56
57 /**
58 * Use the task for a DPD check which detects changes in NAT mappings.
59 */
60 void (*dpd)(ike_mobike_t *this);
61
62 /**
63 * Transmision hook, called by task manager.
64 *
65 * The task manager calls this hook whenever it transmits a packet. It
66 * allows the mobike task to send the packet on multiple paths to do path
67 * probing.
68 *
69 * @param packet the packet to transmit
70 */
71 void (*transmit)(ike_mobike_t *this, packet_t *packet);
72
73 /**
74 * Check if this task is probing for routability.
75 *
76 * @return TRUE if task is probing
77 */
78 bool (*is_probing)(ike_mobike_t *this);
79 };
80
81 /**
82 * Create a new ike_mobike task.
83 *
84 * @param ike_sa IKE_SA this task works for
85 * @param initiator TRUE if taks is initiated by us
86 * @return ike_mobike task to handle by the task_manager
87 */
88 ike_mobike_t *ike_mobike_create(ike_sa_t *ike_sa, bool initiator);
89
90 #endif /** IKE_MOBIKE_H_ @}*/