ikev1: Handle queued TRANSACTION messages only after processing replies
[strongswan.git] / src / libimcv / imc / imc_state.h
1 /*
2 * Copyright (C) 2011-2014 Andreas Steffen
3 * HSR 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 *
18 * @defgroup imc_state_t imc_state
19 * @{ @ingroup libimcv_imc
20 */
21
22 #ifndef IMC_STATE_H_
23 #define IMC_STATE_H_
24
25 #include "seg/seg_contract_manager.h"
26
27 #include <tncif.h>
28 #include <tncifimv.h>
29 #include <tncifimc.h>
30
31 #include <library.h>
32
33 typedef struct imc_state_t imc_state_t;
34
35 /**
36 * Internal state of an IMC connection instance
37 */
38 struct imc_state_t {
39
40 /**
41 * Get the TNCS connection ID attached to the state
42 *
43 * @return TNCS connection ID of the state
44 */
45 TNC_ConnectionID (*get_connection_id)(imc_state_t *this);
46
47 /**
48 * Checks if long message types are supported for this TNCCS connection
49 *
50 * @return TRUE if set, FALSE otherwise
51 */
52 bool (*has_long)(imc_state_t *this);
53
54 /**
55 * Checks if the exclusive delivery is supported for this TNCCS connection
56 *
57 * @return TRUE if set, FALSE otherwise
58 */
59 bool (*has_excl)(imc_state_t *this);
60
61 /**
62 * Sets the long message types and exclusive flags for this TNCCS connection
63 *
64 * @param has_long TNCCS connection supports long message types
65 * @param has_excl TNCCS connection supports exclusive delivery
66 * @return TRUE if set, FALSE otherwise
67 */
68 void (*set_flags)(imc_state_t *this, bool has_long, bool has_excl);
69
70 /**
71 * Set the maximum size of a PA-TNC message for this TNCCS connection
72 *
73 * @param max_msg_len maximum size of a PA-TNC message
74 */
75 void (*set_max_msg_len)(imc_state_t *this, u_int32_t max_msg_len);
76
77 /**
78 * Get the maximum size of a PA-TNC message for this TNCCS connection
79 *
80 * @return maximum size of a PA-TNC message
81 */
82 u_int32_t (*get_max_msg_len)(imc_state_t *this);
83
84 /**
85 * Get attribute segmentation contracts associated with TNCCS Connection
86 *
87 * @return contracts associated with TNCCS Connection
88 */
89 seg_contract_manager_t* (*get_contracts)(imc_state_t *this);
90
91 /**
92 * Change the connection state
93 *
94 * @param new_state new connection state
95 */
96 void (*change_state)(imc_state_t *this, TNC_ConnectionState new_state);
97
98 /**
99 * Set the Assessment/Evaluation Result
100 *
101 * @param id IMC ID
102 * @param result Assessment/Evaluation Result
103 */
104 void (*set_result)(imc_state_t *this, TNC_IMCID id,
105 TNC_IMV_Evaluation_Result result);
106
107 /**
108 * Get the Assessment/Evaluation Result
109 *
110 * @param id IMC ID
111 * @param result Assessment/Evaluation Result
112 * @return TRUE if result is known
113 */
114 bool (*get_result)(imc_state_t *this, TNC_IMCID id,
115 TNC_IMV_Evaluation_Result *result);
116
117 /**
118 * Destroys an imc_state_t object
119 */
120 void (*destroy)(imc_state_t *this);
121 };
122
123 #endif /** IMC_STATE_H_ @}*/