Symbian^3 Application Developer Library >

eap_am_memory_store_c Class Reference

class eap_am_memory_store_c : public abs_eap_am_memory_store_data_c

This class allows EAP objects store data to memory between authentication sessions.

Inherits from

Public Member Functions
eap_am_memory_store_c ( abs_eap_am_tools_c *const )
~eap_am_memory_store_c ()
EAP_FUNC_IMPORT eap_status_e add_data (const eap_variable_data_c *const , const eap_tlv_message_data_c *const , const u32_t )
EAP_FUNC_IMPORT eap_status_e get_data (const eap_variable_data_c *const , eap_tlv_message_data_c *const )
EAP_FUNC_IMPORT bool get_is_valid ()
EAP_FUNC_IMPORT eap_status_e remove_data (const eap_variable_data_c *const )
EAP_FUNC_IMPORT eap_status_e shutdown ()
EAP_FUNC_IMPORT eap_status_e timer_delete_data (const u32_t , void *)
EAP_FUNC_IMPORT eap_status_e timer_expired (const u32_t , void *)
Private Member Functions
EAP_FUNC_IMPORT void set_is_valid ()
Inherited Functions
abs_eap_am_memory_store_data_c::abs_eap_am_memory_store_data_c()
abs_eap_am_memory_store_data_c::~abs_eap_am_memory_store_data_c()
Private Attributes
abs_eap_am_tools_c *const m_am_tools
bool m_is_valid
eap_core_map_c < eap_am_memory_store_tlv_data_c , abs_eap_am_memory_store_data_c , eap_variable_data_c > m_store_new
u32_t m_timer_id_counter

Constructor & Destructor Documentation

eap_am_memory_store_c(abs_eap_am_tools_c *const)

EAP_FUNC_IMPORT eap_am_memory_store_c ( abs_eap_am_tools_c *const tools )

Parameters

abs_eap_am_tools_c *const tools

~eap_am_memory_store_c()

EAP_FUNC_IMPORT ~eap_am_memory_store_c ( ) [virtual]

Member Functions Documentation

add_data(const eap_variable_data_c *const, const eap_tlv_message_data_c *const, const u32_t)

EAP_FUNC_IMPORT eap_status_e add_data ( const eap_variable_data_c *const key,
const eap_tlv_message_data_c *const data,
const u32_t timeout
) [virtual]

Memory store is visible only during the eap_am_tools_c object is alive. This function add flat data to memory store. You must format your data to eap_tlv_message_data_c object. Data is identified by key parameter. You can set timeout to data. Data will be automatically removed after timeout. Timeout value zero means no timeout is set. Serious WARNING: do use really good key values. Memory store is globally used by all EAP Core objects. Key must be good that other users do not use others data. Add the real data type as a string to the key and other identifiers that separate data between the other users that store same data type to the memory store.

Parameters

const eap_variable_data_c *const key
const eap_tlv_message_data_c *const data
const u32_t timeout

get_data(const eap_variable_data_c *const, eap_tlv_message_data_c *const)

EAP_FUNC_IMPORT eap_status_e get_data ( const eap_variable_data_c *const key,
eap_tlv_message_data_c *const data
) [virtual]

Memory store is visible only during the eap_am_tools_c object is alive. This function gets data from memory store. Data is returned in eap_tlv_message_data_c object. Data is identified by key parameter. Serious WARNING: do use really good key values. Memory store is globally used by all EAP Core objects. Key must be good that other users do not use others data. Add the real data type as a string to the key and other identifiers that separate data between the other users that store same data type to the memory store.

Parameters

const eap_variable_data_c *const key
eap_tlv_message_data_c *const data

get_is_valid()

EAP_FUNC_IMPORT bool get_is_valid ( )

remove_data(const eap_variable_data_c *const)

EAP_FUNC_IMPORT eap_status_e remove_data ( const eap_variable_data_c *const key )

Memory store is visible only during the eap_am_tools_c object is alive. This function removes data from memory store. Data is identified by key parameter. Serious WARNING: do use really good key values. Memory store is globally used by all EAP Core objects. Key must be good that other users do not use others data. Add the real data type as a string to the key and other identifiers that separate data between the other users that store same data type to the memory store.

Parameters

const eap_variable_data_c *const key

set_is_valid()

EAP_FUNC_IMPORT void set_is_valid ( ) [private]

shutdown()

EAP_FUNC_IMPORT eap_status_e shutdown ( )

timer_delete_data(const u32_t, void *)

EAP_FUNC_IMPORT eap_status_e timer_delete_data ( const u32_t id,
void * data
)

This function is called when timer event is deleted. Initialiser of the data must delete the data. Only the initializer knows the real type of data.

Parameters

const u32_t id could be used to separate different timer events.
void * data could be pointer to any data that is needed in timer processing.

timer_expired(const u32_t, void *)

EAP_FUNC_IMPORT eap_status_e timer_expired ( const u32_t id,
void * data
)

Function timer_expired() is called after the timer is elapsed.

Parameters

const u32_t id could be used to separate different timer events.
void * data could be pointer to any data that is needed in timer processing.

Member Data Documentation

abs_eap_am_tools_c *const m_am_tools

abs_eap_am_tools_c *const m_am_tools [private]

bool m_is_valid

bool m_is_valid [private]

eap_core_map_c< eap_am_memory_store_tlv_data_c, abs_eap_am_memory_store_data_c, eap_variable_data_c > m_store_new

eap_core_map_c < eap_am_memory_store_tlv_data_c , abs_eap_am_memory_store_data_c , eap_variable_data_c > m_store_new [private]

u32_t m_timer_id_counter

u32_t m_timer_id_counter [private]

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.