|
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 /* |
|
19 * %version: 6 % |
|
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" |
|
27 |
|
28 class eap_method_settings_c; |
|
29 class abs_eap_plugin_message_c; |
|
30 |
|
31 class EAP_EXPORT eap_plugin_message_base_c |
|
32 { |
|
33 private: |
|
34 //-------------------------------------------------- |
|
35 |
|
36 |
|
37 //-------------------------------------------------- |
|
38 protected: |
|
39 //-------------------------------------------------- |
|
40 |
|
41 //-------------------------------------------------- |
|
42 public: |
|
43 //-------------------------------------------------- |
|
44 |
|
45 /** |
|
46 * The destructor of the eap_core class does nothing special. |
|
47 */ |
|
48 EAP_FUNC_IMPORT virtual ~eap_plugin_message_base_c(); |
|
49 |
|
50 /** |
|
51 * The constructor initializes member attributes using parameters passed to it. |
|
52 * @param tools is pointer to the tools class. @see abs_eap_am_tools_c. |
|
53 * @param partner is back pointer to object which created this object. |
|
54 * @param is_client_when_true indicates whether the network entity should act |
|
55 * as a client (true) or server (false), in terms of EAP-protocol |
|
56 * whether this network entity is EAP-supplicant (true) or EAP-authenticator (false). |
|
57 */ |
|
58 EAP_FUNC_IMPORT eap_plugin_message_base_c(); |
|
59 |
|
60 /** |
|
61 * This function must reset the state of object to same as |
|
62 * state was after the configure() function call. |
|
63 * If object reset succeeds this function must return eap_status_ok. |
|
64 * If object reset fails this function must return corresponding error status. |
|
65 * @return This function returns the status of reset operation. |
|
66 */ |
|
67 virtual eap_status_e reset() = 0; |
|
68 |
|
69 // This is documented in abs_eap_stack_interface_c::configure(). |
|
70 virtual eap_status_e configure() = 0; |
|
71 |
|
72 // This is documented in abs_eap_stack_interface_c::shutdown(). |
|
73 virtual eap_status_e shutdown() = 0; |
|
74 |
|
75 // This is documented in abs_eap_stack_interface_c::get_is_valid(). |
|
76 virtual bool get_is_valid() = 0; |
|
77 |
|
78 virtual eap_status_e get_configuration(const eap_method_settings_c * const internal_settings) = 0; |
|
79 |
|
80 virtual eap_status_e set_configuration(const eap_method_settings_c * const internal_settings) = 0; |
|
81 |
|
82 virtual eap_status_e copy_configuration(const eap_method_settings_c * const internal_settings) = 0; |
|
83 |
|
84 virtual eap_status_e delete_configuration(const eap_method_settings_c * const internal_settings) = 0; |
|
85 |
|
86 virtual eap_status_e set_index(const eap_method_settings_c * const internal_settings) = 0; |
|
87 |
|
88 virtual eap_status_e get_type_info(const eap_method_settings_c * const internal_settings) = 0; |
|
89 |
|
90 virtual eap_status_e invoke_ui(const eap_method_settings_c * const internal_settings) = 0; |
|
91 |
|
92 //-------------------------------------------------- |
|
93 |
|
94 static eap_plugin_message_base_c * new_eap_plugin_client_message_if_c( |
|
95 abs_eap_am_tools_c * const tools, |
|
96 abs_eap_plugin_message_c * const partner); |
|
97 |
|
98 //-------------------------------------------------- |
|
99 }; // class eap_plugin_message_base_c |
|
100 |
|
101 //-------------------------------------------------- |
|
102 |
|
103 #endif //#if !defined(_EAP_PLUGIN_MESSAGE_BASE_H_) |
|
104 |
|
105 //-------------------------------------------------- |
|
106 |
|
107 |
|
108 |
|
109 // End. |