aaa526963c78af03db831e464dfcf0ca6bdd31f1
[strongswan.git] / src / charon / plugins / ha_sync / ha_sync_socket.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_socket ha_sync_socket
18 * @{ @ingroup ha_sync
19 */
20
21 #ifndef HA_SYNC_SOCKET_H_
22 #define HA_SYNC_SOCKET_H_
23
24 #include "ha_sync_message.h"
25
26 /**
27 * UDP port we use for communication
28 */
29 #define HA_SYNC_PORT 4510
30
31 typedef struct ha_sync_socket_t ha_sync_socket_t;
32
33 /**
34 * Socket to send/received SA synchronization data
35 */
36 struct ha_sync_socket_t {
37
38 /**
39 * Push synchronization information to the responsible node.
40 *
41 * @param message message to send
42 */
43 void (*push)(ha_sync_socket_t *this, ha_sync_message_t *message);
44
45 /**
46 * Pull synchronization information from a peer we are responsible.
47 *
48 * @return received message
49 */
50 ha_sync_message_t *(*pull)(ha_sync_socket_t *this);
51
52 /**
53 * Destroy a ha_sync_socket_t.
54 */
55 void (*destroy)(ha_sync_socket_t *this);
56 };
57
58 /**
59 * Create a ha_sync_socket instance.
60 */
61 ha_sync_socket_t *ha_sync_socket_create();
62
63 #endif /* HA_SYNC_SOCKET_ @}*/