implemented more aggressive MOBIKE path probing
[strongswan.git] / src / charon / sa / tasks / ike_mobike.h
1 /**
2 * @file ike_mobike.h
3 *
4 * @brief Interface ike_mobike_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2007 Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
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 * @brief 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 * @b Constructors:
44 * - ike_mobike_create()
45 *
46 * @ingroup tasks
47 */
48 struct ike_mobike_t {
49
50 /**
51 * Implements the task_t interface
52 */
53 task_t task;
54
55 /**
56 * @brief Use the task to roam to other addresses.
57 *
58 * @param this calling object
59 * @param address TRUE to include address list update
60 */
61 void (*roam)(ike_mobike_t *this, bool address);
62
63 /**
64 * @brief Transmision hook, called by task manager.
65 *
66 * The task manager calls this hook whenever it transmits a packet. It
67 * allows the mobike task to send the packet on multiple paths to do path
68 * probing.
69 *
70 * @param this calling object
71 * @param packet the packet to transmit
72 */
73 void (*transmit)(ike_mobike_t *this, packet_t *packet);
74
75 /**
76 * @brief Check if this task is probing for routability.
77 *
78 * @param this calling object
79 * @return TRUE if task is probing
80 */
81 bool (*is_probing)(ike_mobike_t *this);
82 };
83
84 /**
85 * @brief Create a new ike_mobike task.
86 *
87 * @param ike_sa IKE_SA this task works for
88 * @param initiator TRUE if taks is initiated by us
89 * @return ike_mobike task to handle by the task_manager
90 */
91 ike_mobike_t *ike_mobike_create(ike_sa_t *ike_sa, bool initiator);
92
93 #endif /* IKE_MOBIKE_H_ */
94