aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/config/policy_store.h
blob: 467e27d1d7e9dd38097ffe5791ba00fa681c1b6e (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
/**
 * @file policy_store.h
 * 
 * @brief Interface policy_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 POLICY_STORE_H_
#define POLICY_STORE_H_

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


typedef struct policy_store_t policy_store_t;

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

	/**
	 * @brief Returns a policy identified by two IDs.
	 * 
	 * The returned policy gets created/cloned and therefore must be
	 * destroyed by the caller.
	 * 
	 * @param this		calling object
	 * @param my_id		own ID of the policy
	 * @param other_id	others ID of the policy
	 * @return
	 *					- matching policy_t, if found
	 * 					- NULL otherwise
	 */
	policy_t *(*get_policy) (policy_store_t *this, identification_t *my_id, identification_t *other_id);
	
	/**
	 * @brief Destroys a policy_store_t object.
	 * 
	 * @param this 					calling object
	 */
	void (*destroy) (policy_store_t *this);
};

#endif /*POLICY_STORE_H_*/