eap_state_notification_c Class Reference
class eap_state_notification_c : public abs_eap_state_notification_c |
Public Member Functions |
---|
| eap_state_notification_c(abs_eap_am_tools_c *const , const eap_am_network_id_c *const , bool, eap_state_notification_generic_e, eap_protocol_layer_e, u32_t, u32_t, u32_t, u8_t, bool) |
| eap_state_notification_c(abs_eap_am_tools_c *const , const eap_am_network_id_c *const , bool, eap_state_notification_eap_e, eap_protocol_layer_e, eap_type_ietf_values_e, u32_t, u32_t, u8_t, bool) |
| ~eap_state_notification_c() |
EAP_FUNC_IMPORT bool | get_allow_send_eap_success() |
EAP_FUNC_IMPORT eap_status_e | get_authentication_error() |
EAP_FUNC_IMPORT u32_t | get_current_state() |
EAP_FUNC_IMPORT eap_const_string | get_current_state_string() |
EAP_FUNC_IMPORT u8_t | get_eap_identifier() |
EAP_FUNC_IMPORT eap_type_value_e | get_eap_type() |
EAP_FUNC_IMPORT bool | get_is_client() |
EAP_FUNC_IMPORT bool | get_needs_confirmation_from_user() |
EAP_FUNC_IMPORT const eap_variable_data_c * | get_notification_string() |
EAP_FUNC_IMPORT u32_t | get_previous_state() |
EAP_FUNC_IMPORT eap_const_string | get_previous_state_string() |
EAP_FUNC_IMPORT u32_t | get_protocol() |
EAP_FUNC_IMPORT eap_protocol_layer_e | get_protocol_layer() |
EAP_FUNC_IMPORT eap_const_string | get_protocol_layer_string(const u32_t) |
EAP_FUNC_IMPORT eap_const_string | get_protocol_layer_string() |
EAP_FUNC_IMPORT eap_const_string | get_protocol_string(const u32_t, const u32_t) |
EAP_FUNC_IMPORT eap_const_string | get_protocol_string() |
EAP_FUNC_IMPORT const eap_am_network_id_c * | get_send_network_id() |
EAP_FUNC_IMPORT eap_const_string | get_state_string(const u32_t, const u32_t) |
EAP_FUNC_IMPORT void | set_authentication_error(const eap_status_e) |
EAP_FUNC_IMPORT eap_status_e | set_notification_string(const eap_variable_data_c *const , const bool) |
Constructor & Destructor Documentation
eap_state_notification_c(abs_eap_am_tools_c *const, const eap_am_network_id_c *const, bool, eap_state_notification_generic_e, eap_protocol_layer_e, u32_t, u32_t, u32_t, u8_t, bool)
eap_state_notification_c(abs_eap_am_tools_c *const, const eap_am_network_id_c *const, bool, eap_state_notification_eap_e, eap_protocol_layer_e, eap_type_ietf_values_e, u32_t, u32_t, u8_t, bool)
~eap_state_notification_c()
EAP_FUNC_IMPORT | ~eap_state_notification_c | ( | ) | [virtual] |
Member Functions Documentation
get_allow_send_eap_success()
EAP_FUNC_IMPORT bool | get_allow_send_eap_success | ( | ) | const [virtual] |
This function sets flag that allows EAP-Core to send EAP-Response/Success.
get_authentication_error()
EAP_FUNC_IMPORT eap_status_e | get_authentication_error | ( | ) | const [virtual] |
get_current_state()
EAP_FUNC_IMPORT u32_t | get_current_state | ( | ) | const [virtual] |
This returns the current state. This is plain 32-bit value because of easy abstraction. Later we could do more detailed information. Each protocol layer and EAP type should define own internal states.
get_current_state_string()
This returns the current state string.
get_eap_identifier()
EAP_FUNC_IMPORT u8_t | get_eap_identifier | ( | ) | const [virtual] |
This returns EAP-Identifier.
get_eap_type()
This returns the protocol on the layer that send this notification. This is eap_type_value_e value. Before using this check the get_protocol_layer() returns eap_protocol_layer_eap, eap_protocol_layer_eap_type, eap_protocol_layer_general or eap_protocol_layer_internal_type.
get_is_client()
EAP_FUNC_IMPORT bool | get_is_client | ( | ) | const [virtual] |
This returns true when notifier is client, false when server.
get_needs_confirmation_from_user()
EAP_FUNC_IMPORT bool | get_needs_confirmation_from_user | ( | ) | const [virtual] |
This function gets flag that tells whether there should be user action to confirm the text.
get_notification_string()
This function gets the notification text that is displayed to user.
get_previous_state()
EAP_FUNC_IMPORT u32_t | get_previous_state | ( | ) | const [virtual] |
This returns the previous state. This is plain 32-bit value because of easy abstraction. Later we could do more detailed information. Each protocol layer and EAP type should define own internal states.
get_previous_state_string()
This returns the previous state string.
get_protocol()
EAP_FUNC_IMPORT u32_t | get_protocol | ( | ) | const [virtual] |
This returns the protocol on the layer that send this notification. This is plain 32-bit value because of easy abstraction. Later we could do more detailed information. Each protocol layer and EAP type should define own internal states.
get_protocol_layer()
This returns the protocol layer that send this notification.
get_protocol_layer_string(const u32_t)
Parameters
const u32_t protocol_layer | |
get_protocol_layer_string()
This returns the protocol layer string string.
get_protocol_string(const u32_t, const u32_t)
get_protocol_string()
This returns the protocol string string.
get_send_network_id()
This returns send network id.
get_state_string(const u32_t, const u32_t)
set_authentication_error(const eap_status_e)
EAP_FUNC_IMPORT void | set_authentication_error | ( | const eap_status_e | error | ) | [virtual] |
set_notification_string(const eap_variable_data_c *const, const bool)
EAP_FUNC_IMPORT eap_status_e | set_notification_string | ( | const eap_variable_data_c *const | notification_string, |
| const bool | needs_confirmation_from_user |
| ) | [virtual] |
This function sets notification text that is displayed to user. Text must be localized string. Type of the string is known to adaptation modules. Type depends on the running environment. Value true of the parameter needs_confirmation_from_user tells whether there should be user action to confirm the text. When notification is information where user action is not needed the needs_confirmation_from_user parameter should be false. Mostly it is better to set this false to disrupt the user less.
Member Data Documentation
bool m_allow_send_eap_success
bool | m_allow_send_eap_success | [private] |
abs_eap_am_tools_c *const m_am_tools
eap_status_e
m_authentication_error
u32_t
m_current_state
u32_t
| m_current_state | [private] |
u8_t
m_eap_identifier
u8_t
| m_eap_identifier | [private] |
eap_type_value_e
m_eap_type
eap_protocol_layer_e
m_layer
bool m_needs_confirmation_from_user
bool | m_needs_confirmation_from_user | [private] |
eap_variable_data_c
m_notification_string
u32_t
m_previous_state
u32_t
| m_previous_state | [private] |
u32_t
m_protocol
u32_t
| m_protocol | [private] |
const eap_am_network_id_c * m_send_network_id
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.