aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/config/connection_store.h
blob: 8b80c0fea13bd039d129717e80242843b459656c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/**
 * @file connection_store.h
 *
 * @brief Interface connection_store_t.
 *
 */

/*
 * Copyright (C) 2006 Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef CONNECTION_STORE_H_
#define CONNECTION_STORE_H_

#include <types.h>
#include <config/connection.h>


typedef struct connection_store_t connection_store_t;

/**
 * @brief The interface for a store of connection_t's.
 * 
 * @b Constructors:
 * 	- stroke_create()
 * 
 * @ingroup config
 */
struct connection_store_t { 

	/**
	 * @brief Returns a connection definition identified by two IDs.
	 * 
	 * This call is usefull to get a connection identified by addresses.
	 * It may be used after kernel request for traffic protection.
	 * The returned connection gets created/cloned and therefore must
	 * be destroyed after usage.
	 * 
	 * @param this				calling object
	 * @param my_id				own ID of connection
	 * @param other_id			others ID of connection
	 * @return		
	 * 							- connection_t, if found
	 * 							- NULL otherwise
	 */
	connection_t *(*get_connection_by_ids) (connection_store_t *this, identification_t *my_id, identification_t *other_id);

	/**
	 * @brief Returns a connection definition identified by two hosts.
	 * 
	 * This call is useful to get a connection which is identified by IDs
	 * rather than addresses, e.g. for connection setup on user request.
	 * The returned connection gets created/cloned and therefore must
	 * be destroyed after usage.
	 * 
	 * @param this				calling object
	 * @param my_id				own address of connection
	 * @param other_id			others address of connection
	 * @return		
	 * 							- connection_t, if found
	 * 							- NULL otherwise
	 */
	connection_t *(*get_connection_by_hosts) (connection_store_t *this, host_t *my_host, host_t *other_host);

	/**
	 * @brief Destroys a connection_store_t object.
	 * 
	 * @param this 					calling object
	 */
	void (*destroy) (connection_store_t *this);
};

#endif /*CONNECTION_STORE_H_*/