eap_base_type_c Class Reference
Constructor & Destructor Documentation
eap_base_type_c(abs_eap_am_tools_c *const, abs_eap_base_type_c *const)
The constructor of the eap_base_type class simply initializes the attributes. abs_eap_am_tools_c.
Parameters
abs_eap_am_tools_c *const tools | is pointer to the tools class. |
abs_eap_base_type_c *const partner | is back pointer to object which created this object. The eap_base_type_c object sends packets to the network using m_type_partner object. |
~eap_base_type_c()
EAP_FUNC_IMPORT | ~eap_base_type_c | ( | ) | [virtual] |
The destructor of the eap_base_type class does nothing special.
Member Functions Documentation
configure()
The configure() function is called after the constructor of the object is successfully executed. During the function call the object could query the configuration. Each derived class must define this function. Needed configuration depends on the EAP-type.
eap_acknowledge(const eap_am_network_id_c *const)
The adaptation module calls the eap_acknowledge() function after any Network Protocol packet is received. This is used as a success indication. This is described in RFC 2284 "PPP Extensible Authentication Protocol (EAP)". Mostly there is only one session in the client. The server does not need eap_acknowledge() function because server (EAP-authenticator) sends the EAP-success message.
get_is_valid()
bool | get_is_valid | ( | ) | [pure virtual] |
Object must indicate it's validity. If object initialization fails this function must return false.
get_type_partner()
Type partner is object below the EAP-type object.
object_decrease_reference_count()
EAP_FUNC_IMPORT u32_t | object_decrease_reference_count | ( | ) | |
The object_decrease_reference_count () function decreases the reference count and returns the remaining value. The EAP type is removed after there is no references to it.
object_increase_reference_count()
EAP_FUNC_IMPORT void | object_increase_reference_count | ( | ) | |
packet_process(const eap_am_network_id_c *const, eap_header_wr_c *const, const u32_t)
This function processes the received packet. The return value of this function should be used only for traces and error counters. You MUST NOT make any decision of authentication session based on the return value. The stack calls abs_eap_core_c::state_notification() function when authentication session terminates unsuccessfully or ends successfully. You MUST make decision of authentication session based on the state_notification() call. See more abs_eap_core_c::state_notification().
Parameters
const eap_am_network_id_c *const receive_network_id | carries the addresses and type of the received packet. |
eap_header_wr_c *const eap | includes the buffer of the packet. |
const u32_t packet_length | is length in bytes of the EAP-packet. |
query_eap_identity(const bool, eap_variable_data_c *const, const eap_am_network_id_c *const, const u8_t)
Parameters
const bool must_be_synchronous | tells whether this call must be synchronous. |
eap_variable_data_c *const identity | is buffer for queried identity in synchronous call. |
const eap_am_network_id_c *const receive_network_id | carries the addresses and type of the received packet. |
const u8_t eap_identifier | is EAP-Identifier for EAP-Response/Identity packet. |
reset()
This function resets the reused object.
set_initial_eap_identifier(const eap_am_network_id_c *const, const u8_t)
This function sets the initial EAP-Identifier to be used for the first sent packet. This function is only needed in Windows RAS.
set_is_valid()
void | set_is_valid | ( | ) | [private, pure virtual] |
The set_is_valid() function sets the state of the object valid. The creator of this object calls this function after it is initialized.
shutdown()
The shutdown() function is called before the destructor of the object is executed. During the function call the object could shutdown the operations, for example cancel timers. Each derived class must define this function.
Member Data Documentation
abs_eap_am_tools_c *const m_am_tools
u32_t
m_reference_count
u32_t
| m_reference_count | [private] |
This is count of references to this EAP-type. EAP-type is removed from eap_core_map_c after the reference count is zero.
abs_eap_base_type_c * m_type_partner
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.