abs_eap_stack_interface_c Class Reference

class abs_eap_stack_interface_c

The abs_eap_stack_interface_c class declares common pure virtual functions a lower layer class of EAP-stack could call from upper layer class. Main purpose of this interface is documenting those functions. Note the each interface could include other functions too. Those are defined in each individual interface.

Constructor & Destructor Documentation



The constructor of the abs_eap_stack_interface_c does nothing special.


~abs_eap_stack_interface_c()[inline, virtual]

The destructor of the abs_eap_stack_interface_c class does nothing special.

Member Functions Documentation


eap_status_e configure()[pure virtual]

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 implementation.


boolget_is_valid()[pure virtual]

Object must indicate it's validity. If object initialization fails this function must return false.

packet_process(const eap_am_network_id_c *const, eap_general_header_base_c *const, const u32_t)

eap_status_e packet_process(const eap_am_network_id_c *const receive_network_id,
eap_general_header_base_c *const packet_data,
const u32_tpacket_length
)[pure virtual]

The packet_process() 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().


const eap_am_network_id_c *const receive_network_idcarries the addresses and type of the received packet.
eap_general_header_base_c *const packet_dataincludes the buffer of the packet.
const u32_t packet_lengthis length in bytes of the EAP-packet.


voidset_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.


eap_status_e shutdown()[pure virtual]

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.