abs_eap_core_c Class Reference
This class defines the interface the eap_core_c class will use with the partner class (lower layer).
Public Member Functions |
---|
| abs_eap_core_c() |
| ~abs_eap_core_c() |
eap_status_e
| add_rogue_ap(eap_array_c< eap_rogue_ap_entry_c > &) |
eap_status_e
| asynchronous_init_remove_eap_session(const eap_am_network_id_c *const ) |
eap_status_e
| cancel_all_timers() |
eap_status_e
| cancel_timer(abs_eap_base_timer_c *const , const u32_t) |
eap_status_e
| check_is_valid_eap_type(const eap_type_value_e) |
eap_status_e
| get_eap_type_list(eap_array_c< eap_type_value_e > *const ) |
u32_t
| get_header_offset(u32_t *const , u32_t *const ) |
eap_status_e
| load_module(const eap_type_value_e, const , abs_eap_base_type_c *const , eap_base_type_c **const , const bool, const eap_am_network_id_c *const ) |
eap_status_e
| packet_data_crypto_keys(const eap_am_network_id_c *const , const eap_master_session_key_c *const ) |
eap_status_e
| packet_send(const eap_am_network_id_c *const , eap_buf_chain_wr_c *const , const u32_t, const u32_t, const u32_t) |
eap_status_e
| read_configure(const eap_configuration_field_c *const , eap_variable_data_c *const ) |
eap_status_e
| restart_authentication(const eap_am_network_id_c *const , const bool, const bool, const bool) |
eap_status_e
| set_session_timeout(const u32_t) |
eap_status_e
| set_timer(abs_eap_base_timer_c *const , const u32_t, void *const , const u32_t) |
void | state_notification(const abs_eap_state_notification_c *const ) |
eap_status_e
| unload_module(const eap_type_value_e) |
eap_status_e
| write_configure(const eap_configuration_field_c *const , eap_variable_data_c *const ) |
Constructor & Destructor Documentation
abs_eap_core_c()
The constructor of the abs_eap_core class does nothing special.
~abs_eap_core_c()
~abs_eap_core_c | ( | ) | [inline, virtual] |
The destructor of the abs_eap_core class does nothing special.
Member Functions Documentation
add_rogue_ap(eap_array_c< eap_rogue_ap_entry_c > &)
asynchronous_init_remove_eap_session(const eap_am_network_id_c *const)
This function tells lower layer to remove EAP session object asyncronously.
cancel_all_timers()
The cancel_all_timers() function cancels all timers. User should use this in termination of the stack before the adaptation module of tools is deleted. Preferred mode is to cancel each timer directly using cancel_timer() function.
Adaptation module internally implements the timer.
cancel_timer(abs_eap_base_timer_c *const, const u32_t)
The cancel_timer() function cancels the timer id initiated by initializer. Adaptation module internally implements the timer.
Parameters
abs_eap_base_timer_c *const initializer | is pointer to object which set the cancelled timer. |
const u32_t id | is identifier which will be returned in timer_expired() function. The user selects and interprets the id for this timer. |
check_is_valid_eap_type(const eap_type_value_e)
This function queries the validity of EAP-type. Lower layer should return eap_status_ok if this EAP-type is supported.
get_eap_type_list(eap_array_c< eap_type_value_e > *const)
This function queries the list of supported EAP-types. Lower layer should return eap_status_ok if this call succeeds.
Parameters
eap_array_c< eap_type_value_e > *const eap_type_list | will include the list of supported EAP-types. Each value in list is type of u32_t and represent one supported EAP-type. List consists of subsequent u32_t type values. |
get_header_offset(u32_t *const, u32_t *const)
u32_t
| get_header_offset | ( | u32_t *const | MTU, |
| u32_t *const | trailer_length |
| ) | [pure virtual] |
load_module(const eap_type_value_e, const, abs_eap_base_type_c *const, eap_base_type_c **const, const bool, const eap_am_network_id_c *const)
The load_module() function function indicates the lower level to load new module of EAP-type.
Parameters
const eap_type_value_e type | is the requested EAP-type. |
const eap_type_value_e | |
abs_eap_base_type_c *const partner | is pointer to the caller object. The partner of the new created EAP-type object is the caller object. |
eap_base_type_c **const eap_type | is a pointer to a pointer of EAP-type object. Adaptation module sets eap_type pointer to created EAP-type object. |
const bool is_client_when_true | parameter indicates whether the network entity should act as a client (true) or server (false), in terms of EAP-protocol whether this network entity is EAP-supplicant (true) or EAP-authenticator (false). |
const eap_am_network_id_c *const receive_network_id | includes the addresses (network identity) and packet type. |
packet_data_crypto_keys(const eap_am_network_id_c *const, const eap_master_session_key_c *const)
packet_send(const eap_am_network_id_c *const, eap_buf_chain_wr_c *const, const u32_t, const u32_t, const u32_t)
read_configure(const eap_configuration_field_c *const, eap_variable_data_c *const)
restart_authentication(const eap_am_network_id_c *const, const bool, const bool, const bool)
eap_status_e
| restart_authentication | ( | const eap_am_network_id_c *const | receive_network_id, |
| const bool | is_client_when_true, |
| const bool | force_clean_restart, |
| const bool | from_timer = false |
| ) | [pure virtual] |
The session calls the restart_authentication() function when EAP-authentication is needed with another peer. This is also used when session restarts authentication.
Parameters
const eap_am_network_id_c *const receive_network_id | includes the addresses (network identity) and packet type. |
const bool is_client_when_true | indicates whether the EAP-type should act as a client or server, in terms of EAP-protocol whether this network entity is EAP-supplicant (true) or EAP-authenticator (false). |
const bool force_clean_restart | this selects whether the server removes this session (true) or not (false). |
const bool from_timer = false | tells whether the timer calls this function (true) or not (false). |
set_session_timeout(const u32_t)
The set_session_timeout() function changes the session timeout timer to be elapsed after session_timeout_ms milliseconds.
Parameters
const u32_t session_timeout_ms | |
set_timer(abs_eap_base_timer_c *const, const u32_t, void *const, const u32_t)
The set_timer() function initializes timer to be elapsed after time_ms milliseconds. Adaptation module internally implements the timer.
Parameters
abs_eap_base_timer_c *const initializer | is pointer to object which timer_expired() function will be called after timer elapses. |
const u32_t id | is identifier which will be returned in timer_expired() function. The user selects and interprets the id for this timer. |
void *const data | is pointer to any user selected data which will be returned in timer_expired() function. |
const u32_t time_ms | is the time of timer in milli seconds. |
state_notification(const abs_eap_state_notification_c *const)
unload_module(const eap_type_value_e)
write_configure(const eap_configuration_field_c *const, eap_variable_data_c *const)
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.