Symbian^3 Application Developer Library >

eap_general_header_base_c Class Reference

class eap_general_header_base_c

This is general base class defining the view to packet header.

Public Member Functions
eap_general_header_base_c ( abs_eap_am_tools_c *const , void *const , const u32_t )
~eap_general_header_base_c ()
eap_status_e check_header ()
EAP_FUNC_IMPORT abs_eap_am_tools_c * get_am_tools ()
EAP_FUNC_IMPORT u8_t * get_header_buffer (const u32_t )
EAP_FUNC_IMPORT u32_t get_header_buffer_length ()
EAP_FUNC_IMPORT u8_t * get_header_offset (const u32_t , const u32_t )
EAP_FUNC_IMPORT bool get_is_valid ()
EAP_FUNC_IMPORT void set_header_buffer ( u8_t *const , const u32_t )
Private Attributes
abs_eap_am_tools_c *const m_am_tools
u8_t * m_header_buffer
u32_t m_header_buffer_length

Constructor & Destructor Documentation

eap_general_header_base_c(abs_eap_am_tools_c *const, void *const, const u32_t)

EAP_FUNC_IMPORT eap_general_header_base_c ( abs_eap_am_tools_c *const tools,
void *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 the packet including header and data. The header_buffer_length parameter is length of the header_buffer.

Parameters

abs_eap_am_tools_c *const tools
void *const header_buffer
const u32_t header_buffer_length

~eap_general_header_base_c()

EAP_FUNC_IMPORT ~eap_general_header_base_c ( ) [virtual]

Destructor does nothing special. NOTE the header buffer is not deleted here.

Member Functions Documentation

check_header()

eap_status_e check_header ( ) const [pure virtual]

get_am_tools()

EAP_FUNC_IMPORT abs_eap_am_tools_c * get_am_tools ( ) const

get_header_buffer(const u32_t)

EAP_FUNC_IMPORT u8_t * get_header_buffer ( const u32_t data_length ) const

Parameters

const u32_t data_length

get_header_buffer_length()

EAP_FUNC_IMPORT u32_t get_header_buffer_length ( ) const

get_header_offset(const u32_t, const u32_t)

EAP_FUNC_IMPORT u8_t * get_header_offset ( const u32_t offset,
const u32_t data_length
) const

Parameters

const u32_t offset
const u32_t data_length

get_is_valid()

EAP_FUNC_IMPORT bool get_is_valid ( ) const

set_header_buffer(u8_t *const, const u32_t)

EAP_FUNC_IMPORT void set_header_buffer ( u8_t *const header_buffer,
const u32_t header_buffer_length
)

This function sets the buffer of the packet. The header_buffer parameter is pointer to buffer of the packet including header and data. The header_buffer_length parameter is length of the header_buffer.

Parameters

u8_t *const header_buffer
const u32_t header_buffer_length

Member Data Documentation

abs_eap_am_tools_c *const m_am_tools

abs_eap_am_tools_c *const m_am_tools [private]

u8_t * m_header_buffer

u8_t * m_header_buffer [private]

u32_t m_header_buffer_length

u32_t m_header_buffer_length [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.