Moved segment configuration parsing to ha_sync_plugin
[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 "ha_sync_socket.h"
25
26 #include <daemon.h>
27
28 typedef struct ha_sync_segments_t ha_sync_segments_t;
29
30 typedef u_int16_t segment_mask_t;
31
32 /**
33 * maximum number of segments
34 */
35 #define SEGMENTS_MAX (sizeof(segment_mask_t)*8)
36
37 /**
38 * Get the bit in the mask of a segment
39 */
40 #define SEGMENTS_BIT(segment) (0x01 << (segment - 1))
41
42 /**
43 * Segmentation of peers into active and passive.
44 */
45 struct ha_sync_segments_t {
46
47 /**
48 * Activate a set of IKE_SAs identified by a segment.
49 *
50 * @param segment numerical segment to takeover, 0 for all
51 * @param notify wheter to notify other nodes about activation
52 */
53 void (*activate)(ha_sync_segments_t *this, u_int segment, bool notify);
54
55 /**
56 * Deactivate a set of IKE_SAs identified by a segment.
57 *
58 * @param segment numerical segment to takeover, 0 for all
59 * @param notify wheter to notify other nodes about deactivation
60 */
61 void (*deactivate)(ha_sync_segments_t *this, u_int segment, bool notify);
62
63 /**
64 * Resync an active segment.
65 *
66 * To reintegrade a node into the cluster, resynchronization is reqired.
67 * IKE_SAs and CHILD_SAs are synced automatically during rekeying. A call
68 * to this method enforces a rekeying immediately sync all state of a
69 * segment.
70 *
71 * @param segment segment to resync
72 */
73 void (*resync)(ha_sync_segments_t *this, u_int segment);
74
75 /**
76 * Destroy a ha_sync_segments_t.
77 */
78 void (*destroy)(ha_sync_segments_t *this);
79 };
80
81 /**
82 * Create a ha_sync_segments instance.
83 *
84 * @param socket socket to communicate segment (de-)activation
85 * @param count number of segments the cluster uses
86 * @param active bit mask of initially active segments
87 * @return segment object
88 */
89 ha_sync_segments_t *ha_sync_segments_create(ha_sync_socket_t *socket,
90 u_int count, segment_mask_t active);
91
92 #endif /* HA_SYNC_SEGMENTS_ @}*/