26
|
1 |
/*
|
|
2 |
* Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
* All rights reserved.
|
|
4 |
* This component and the accompanying materials are made available
|
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
6 |
* which accompanies this distribution, and is available
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
*
|
|
9 |
* Initial Contributors:
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
11 |
*
|
|
12 |
* Contributors:
|
|
13 |
*
|
|
14 |
* Description: virtual functions of EAP-plugin interface.
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
/*
|
49
|
19 |
* %version: 7 %
|
26
|
20 |
*/
|
|
21 |
|
|
22 |
#if !defined(_EAP_PLUGIN_MESSAGE_BASE_H_)
|
|
23 |
#define _EAP_PLUGIN_MESSAGE_BASE_H_
|
|
24 |
|
|
25 |
#include "eap_tools.h"
|
|
26 |
#include "eap_am_export.h"
|
49
|
27 |
// Start: added by script change_export_macros.sh.
|
|
28 |
#if defined(EAP_NO_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H)
|
|
29 |
#define EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_NONSHARABLE
|
|
30 |
#define EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H
|
|
31 |
#define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H
|
|
32 |
#define EAP_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H
|
|
33 |
#define EAP_C_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H
|
|
34 |
#elif defined(EAP_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H)
|
|
35 |
#define EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_EXPORT
|
|
36 |
#define EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_FUNC_EXPORT
|
|
37 |
#define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_C_FUNC_EXPORT
|
|
38 |
#define EAP_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H EAP_FUNC_EXPORT
|
|
39 |
#define EAP_C_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H EAP_C_FUNC_EXPORT
|
|
40 |
#else
|
|
41 |
#define EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_IMPORT
|
|
42 |
#define EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_FUNC_IMPORT
|
|
43 |
#define EAP_C_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H EAP_C_FUNC_IMPORT
|
|
44 |
#define EAP_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H
|
|
45 |
#define EAP_C_FUNC_EXPORT_EAP_PLUGIN_MESSAGE_BASE_H
|
|
46 |
#endif
|
|
47 |
// End: added by script change_export_macros.sh.
|
26
|
48 |
|
|
49 |
class eap_method_settings_c;
|
|
50 |
class abs_eap_plugin_message_c;
|
|
51 |
|
49
|
52 |
class EAP_CLASS_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H eap_plugin_message_base_c
|
26
|
53 |
{
|
|
54 |
private:
|
|
55 |
//--------------------------------------------------
|
|
56 |
|
|
57 |
|
|
58 |
//--------------------------------------------------
|
|
59 |
protected:
|
|
60 |
//--------------------------------------------------
|
|
61 |
|
|
62 |
//--------------------------------------------------
|
|
63 |
public:
|
|
64 |
//--------------------------------------------------
|
|
65 |
|
|
66 |
/**
|
|
67 |
* The destructor of the eap_core class does nothing special.
|
|
68 |
*/
|
49
|
69 |
EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H virtual ~eap_plugin_message_base_c();
|
26
|
70 |
|
|
71 |
/**
|
|
72 |
* The constructor initializes member attributes using parameters passed to it.
|
|
73 |
* @param tools is pointer to the tools class. @see abs_eap_am_tools_c.
|
|
74 |
* @param partner is back pointer to object which created this object.
|
|
75 |
* @param is_client_when_true indicates whether the network entity should act
|
|
76 |
* as a client (true) or server (false), in terms of EAP-protocol
|
|
77 |
* whether this network entity is EAP-supplicant (true) or EAP-authenticator (false).
|
|
78 |
*/
|
49
|
79 |
EAP_FUNC_VISIBILITY_EAP_PLUGIN_MESSAGE_BASE_H eap_plugin_message_base_c();
|
26
|
80 |
|
|
81 |
/**
|
|
82 |
* This function must reset the state of object to same as
|
|
83 |
* state was after the configure() function call.
|
|
84 |
* If object reset succeeds this function must return eap_status_ok.
|
|
85 |
* If object reset fails this function must return corresponding error status.
|
|
86 |
* @return This function returns the status of reset operation.
|
|
87 |
*/
|
|
88 |
virtual eap_status_e reset() = 0;
|
|
89 |
|
|
90 |
// This is documented in abs_eap_stack_interface_c::configure().
|
|
91 |
virtual eap_status_e configure() = 0;
|
|
92 |
|
|
93 |
// This is documented in abs_eap_stack_interface_c::shutdown().
|
|
94 |
virtual eap_status_e shutdown() = 0;
|
|
95 |
|
|
96 |
// This is documented in abs_eap_stack_interface_c::get_is_valid().
|
|
97 |
virtual bool get_is_valid() = 0;
|
|
98 |
|
|
99 |
virtual eap_status_e get_configuration(const eap_method_settings_c * const internal_settings) = 0;
|
|
100 |
|
|
101 |
virtual eap_status_e set_configuration(const eap_method_settings_c * const internal_settings) = 0;
|
|
102 |
|
|
103 |
virtual eap_status_e copy_configuration(const eap_method_settings_c * const internal_settings) = 0;
|
|
104 |
|
|
105 |
virtual eap_status_e delete_configuration(const eap_method_settings_c * const internal_settings) = 0;
|
|
106 |
|
|
107 |
virtual eap_status_e set_index(const eap_method_settings_c * const internal_settings) = 0;
|
|
108 |
|
|
109 |
virtual eap_status_e get_type_info(const eap_method_settings_c * const internal_settings) = 0;
|
|
110 |
|
|
111 |
virtual eap_status_e invoke_ui(const eap_method_settings_c * const internal_settings) = 0;
|
|
112 |
|
|
113 |
//--------------------------------------------------
|
|
114 |
|
|
115 |
static eap_plugin_message_base_c * new_eap_plugin_client_message_if_c(
|
|
116 |
abs_eap_am_tools_c * const tools,
|
|
117 |
abs_eap_plugin_message_c * const partner);
|
|
118 |
|
|
119 |
//--------------------------------------------------
|
|
120 |
}; // class eap_plugin_message_base_c
|
|
121 |
|
|
122 |
//--------------------------------------------------
|
|
123 |
|
|
124 |
#endif //#if !defined(_EAP_PLUGIN_MESSAGE_BASE_H_)
|
|
125 |
|
|
126 |
//--------------------------------------------------
|
|
127 |
|
|
128 |
|
|
129 |
|
|
130 |
// End.
|