eap_header_wr_c Class Reference

class eap_header_wr_c : public eap_header_base_c

This class is read and write EAP-packet header. This class can be removed. eap_header_base_c could be used instead. }

Public Member Functions
eap_header_wr_c ( abs_eap_am_tools_c *const , u8_t *const , const u32_t )
~eap_header_wr_c ()
EAP_FUNC_IMPORT u8_t * get_type_data (const u32_t )
EAP_FUNC_IMPORT u8_t * get_type_data_offset (const u32_t , const u32_t )
EAP_FUNC_IMPORT void reset_header (const u16_t , const bool)
Inherited Functions
eap_general_header_base_c::eap_general_header_base_c(abs_eap_am_tools_c *const ,void *const ,const u32_t)
eap_general_header_base_c::get_am_tools()const
eap_general_header_base_c::get_header_buffer(const u32_t)const
eap_general_header_base_c::get_header_buffer_length()const
eap_general_header_base_c::get_header_offset(const u32_t,const u32_t)const
eap_general_header_base_c::get_is_valid()const
eap_general_header_base_c::set_header_buffer(u8_t *const ,const u32_t)
eap_general_header_base_c::~eap_general_header_base_c()
eap_header_base_c::check_header()const
eap_header_base_c::eap_header_base_c(abs_eap_am_tools_c *const ,void *const ,const u32_t)
eap_header_base_c::get_code()const
eap_header_base_c::get_code_string()const
eap_header_base_c::get_data(const u32_t)const
eap_header_base_c::get_data_length()const
eap_header_base_c::get_data_offset(const u32_t,const u32_t)const
eap_header_base_c::get_expanded_ietf_type_offset()
eap_header_base_c::get_expanded_type_field_length()
eap_header_base_c::get_expanded_vendor_id_offset()
eap_header_base_c::get_expanded_vendor_type_offset()
eap_header_base_c::get_header_length()
eap_header_base_c::get_identifier()const
eap_header_base_c::get_ietf_type()const
eap_header_base_c::get_ietf_type_field_length()
eap_header_base_c::get_length()const
eap_header_base_c::get_type()const
eap_header_base_c::get_type_data_length()const
eap_header_base_c::get_type_data_start_offset(const bool)
eap_header_base_c::get_type_field_length()const
eap_header_base_c::get_type_string()const
eap_header_base_c::set_code(const eap_code_value_e)
eap_header_base_c::set_identifier(const u8_t)
eap_header_base_c::set_length(const u16_t,const bool)
eap_header_base_c::set_type(const eap_type_value_e,const bool)
eap_header_base_c::set_type_data_length(const u16_t,const bool)
eap_header_base_c::~eap_header_base_c()
Private Attributes
abs_eap_am_tools_c *const m_am_tools

Constructor & Destructor Documentation

eap_header_wr_c(abs_eap_am_tools_c *const, u8_t *const, const u32_t)

EAP_FUNC_IMPORT eap_header_wr_c ( abs_eap_am_tools_c *const tools,
u8_t *const header_buffer,
const u32_t header_buffer_length
)

Constructor does nothing special. The tools parameter is pointer to tools object. The header_buffer parameter is pointer to buffer of EAP-packet including header and data. The header_buffer_length parameter is length of the header_buffer.

Parameters

abs_eap_am_tools_c *const tools
u8_t *const header_buffer
const u32_t header_buffer_length

~eap_header_wr_c()

EAP_FUNC_IMPORT ~eap_header_wr_c ( ) [virtual]

Member Functions Documentation

get_type_data(const u32_t)

EAP_FUNC_IMPORT u8_t * get_type_data ( const u32_t p_continuous_bytes ) const

Parameters

const u32_t p_continuous_bytes

get_type_data_offset(const u32_t, const u32_t)

EAP_FUNC_IMPORT u8_t * get_type_data_offset ( const u32_t p_offset,
const u32_t p_continuous_bytes
) const

Parameters

const u32_t p_offset
const u32_t p_continuous_bytes

reset_header(const u16_t, const bool)

EAP_FUNC_IMPORT void reset_header ( const u16_t buffer_length,
const bool expanded_type_when_true
)

This function resets the EAP-header. The buffer_length parameter is the length of the EAP-header and the following data buffer.

Parameters

const u16_t buffer_length
const bool expanded_type_when_true

Member Data Documentation

abs_eap_am_tools_c *const m_am_tools

abs_eap_am_tools_c *const m_am_tools [private]