Collapse all Symbian^3 Product Developer Library

abs_eap_state_notification_c Class Reference

class abs_eap_state_notification_c

This class is the interface to state notification class. This is mostly used for state indications, debugging and protocol testing. The lower level could get information of the authentication states.

Public Member Functions
	abs_eap_state_notification_c()
	~abs_eap_state_notification_c()
bool	get_allow_send_eap_success()
eap_status_e	get_authentication_error()
u32_t	get_current_state()
eap_const_string	get_current_state_string()
u8_t	get_eap_identifier()
eap_type_value_e	get_eap_type()
bool	get_is_client()
bool	get_needs_confirmation_from_user()
const eap_variable_data_c *	get_notification_string()
u32_t	get_previous_state()
eap_const_string	get_previous_state_string()
u32_t	get_protocol()
eap_protocol_layer_e	get_protocol_layer()
eap_const_string	get_protocol_layer_string()
eap_const_string	get_protocol_string()
const eap_am_network_id_c *	get_send_network_id()
void	set_authentication_error(const eap_status_e)
eap_status_e	set_notification_string(const eap_variable_data_c *const , const bool)

Constructor & Destructor Documentation

abs_eap_state_notification_c()

abs_eap_state_notification_c

(

)

[inline]

The constructor of the abs_eap_state_notification_c class does nothing special.

~abs_eap_state_notification_c()

~abs_eap_state_notification_c

(

)

[inline, virtual]

The destructor of the abs_eap_state_notification_c class does nothing special.

Member Functions Documentation

get_allow_send_eap_success()

bool

get_allow_send_eap_success

(

)

const [pure virtual]

This function sets flag that allows EAP-Core to send EAP-Response/Success.

get_authentication_error()

eap_status_e

get_authentication_error

(

)

const [pure virtual]

This function returns the authentication error when get_protocol_layer() returns eap_protocol_layer_general and get_current_state() returns eap_general_state_authentication_error.

get_current_state()

u32_t

get_current_state

(

)

const [pure 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()

eap_const_string

get_current_state_string

(

)

const [pure virtual]

This returns the current state string.

get_eap_identifier()

u8_t

get_eap_identifier

(

)

const [pure virtual]

This returns EAP-Identifier.

get_eap_type()

eap_type_value_e

get_eap_type

(

)

const [pure virtual]

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()

bool

get_is_client

(

)

const [pure virtual]

This returns true when notifier is client, false when server.

get_needs_confirmation_from_user()

bool

get_needs_confirmation_from_user

(

)

const [pure virtual]

This function gets flag that tells whether there should be user action to confirm the text.

get_notification_string()

const eap_variable_data_c *

get_notification_string

(

)

const [pure virtual]

This function gets the notification text that is displayed to user.

get_previous_state()

u32_t

get_previous_state

(

)

const [pure 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()

eap_const_string

get_previous_state_string

(

)

const [pure virtual]

This returns the previous state string.

get_protocol()

u32_t

get_protocol

(

)

const [pure 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()

eap_protocol_layer_e

get_protocol_layer

(

)

const [pure virtual]

This returns the protocol layer that send this notification.

get_protocol_layer_string()

eap_const_string

get_protocol_layer_string

(

)

const [pure virtual]

This returns the protocol layer string string.

get_protocol_string()

eap_const_string

get_protocol_string

(

)

const [pure virtual]

This returns the protocol string string.

get_send_network_id()

const eap_am_network_id_c *

get_send_network_id

(

)

const [pure virtual]

This returns send network id.

set_authentication_error(const eap_status_e)

void

set_authentication_error

(

const eap_status_e

error

)

[pure virtual]

The authentication error must be set when get_protocol_layer() returns eap_protocol_layer_general and get_current_state() returns eap_general_state_authentication_error.

Parameters

const eap_status_e error

set_notification_string(const eap_variable_data_c *const, const bool)

eap_status_e	set_notification_string	(	const eap_variable_data_c *const	notification_string,
			const bool	needs_confirmation_from_user
		)	[pure 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.

Parameters

const eap_variable_data_c *const notification_string
const bool needs_confirmation_from_user