Do not enable/disable our own sync tunnel
[strongswan.git] / src / charon / plugins / ha_sync / ha_sync_segments.h
1 /*
2 * Copyright (C) 2008 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
16 /**
17 * @defgroup ha_sync_segments ha_sync_segments
18 * @{ @ingroup ha_sync
19 */
20
21 #ifndef HA_SYNC_SEGMENTS_H_
22 #define HA_SYNC_SEGMENTS_H_
23
24 #include <daemon.h>
25
26 typedef struct ha_sync_segments_t ha_sync_segments_t;
27
28 typedef u_int16_t segment_mask_t;
29
30 /**
31 * maximum number of segments
32 */
33 #define SEGMENTS_MAX (sizeof(segment_mask_t)*8)
34
35 /**
36 * Get the bit in the mask of a segment
37 */
38 #define SEGMENTS_BIT(segment) (0x01 << (segment - 1))
39
40 #include "ha_sync_socket.h"
41 #include "ha_sync_tunnel.h"
42 #include "ha_sync_kernel.h"
43
44 /**
45 * Segmentation of peers into active and passive.
46 */
47 struct ha_sync_segments_t {
48
49 /**
50 * Implements listener interface to catch daemon shutdown.
51 */
52 listener_t listener;
53
54 /**
55 * Activate a set of IKE_SAs identified by a segment.
56 *
57 * @param segment numerical segment to takeover, 0 for all
58 * @param notify wheter to notify other nodes about activation
59 */
60 void (*activate)(ha_sync_segments_t *this, u_int segment, bool notify);
61
62 /**
63 * Deactivate a set of IKE_SAs identified by a segment.
64 *
65 * @param segment numerical segment to takeover, 0 for all
66 * @param notify wheter to notify other nodes about deactivation
67 */
68 void (*deactivate)(ha_sync_segments_t *this, u_int segment, bool notify);
69
70 /**
71 * Resync an active segment.
72 *
73 * To reintegrade a node into the cluster, resynchronization is reqired.
74 * IKE_SAs and CHILD_SAs are synced automatically during rekeying. A call
75 * to this method enforces a rekeying immediately sync all state of a
76 * segment.
77 *
78 * @param segment segment to resync
79 */
80 void (*resync)(ha_sync_segments_t *this, u_int segment);
81
82 /**
83 * Destroy a ha_sync_segments_t.
84 */
85 void (*destroy)(ha_sync_segments_t *this);
86 };
87
88 /**
89 * Create a ha_sync_segments instance.
90 *
91 * @param socket socket to communicate segment (de-)activation
92 * @param kernel interface to control segments at kernel level
93 * @param count number of segments the cluster uses
94 * @param active bit mask of initially active segments
95 * @return segment object
96 */
97 ha_sync_segments_t *ha_sync_segments_create(ha_sync_socket_t *socket,
98 ha_sync_kernel_t *kernel,
99 ha_sync_tunnel_t *tunnel,
100 u_int count, segment_mask_t active);
101
102 #endif /* HA_SYNC_SEGMENTS_ @}*/