wlan_bearer/wlanengine/wlan_common/wlanengine_common_3.1/inc/core_frame_rm_ie_beacon_report_frame_body_ie.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of the License "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Class for parsing RM Beacon Report Frame Body IEs.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CORE_FRAME_RM_IE_BEACON_REPORT_FRAME_BODY_IE_H
       
    20 #define CORE_FRAME_RM_IE_BEACON_REPORT_FRAME_BODY_IE_H
       
    21 
       
    22 #include "core_frame_rm_ie.h"
       
    23 #include "core_types.h"
       
    24 #include "core_ap_data.h"
       
    25 
       
    26 /**
       
    27  * Class for parsing Beacon Report Element IE.
       
    28  *
       
    29  * @since S60 v5.2
       
    30  */
       
    31 NONSHARABLE_CLASS( core_frame_rm_ie_beacon_report_frame_body_ie_c ) : public core_frame_dot11_ie_c
       
    32     {
       
    33 
       
    34 public:
       
    35 
       
    36     enum core_frame_rm_ie_beacon_report_frame_body_ie_element_id_e
       
    37         {
       
    38         core_frame_rm_ie_beacon_report_frame_body_ie_element_id_reported_frame_body = 1
       
    39         };
       
    40 
       
    41     /**
       
    42      * Factory for creating a Beacon Report Frame Body IE
       
    43      * instance with given parameters.
       
    44      *
       
    45      * @since S60 v5.2
       
    46      * @param ap_data Reference to core_ap_data_c from which to generate the information.
       
    47      */
       
    48     static core_frame_rm_ie_beacon_report_frame_body_ie_c* instance(
       
    49         core_ap_data_c& ap_data );
       
    50 
       
    51     /**
       
    52      * Factory for creating a Beacon Report Frame Body IE
       
    53      * instance with given parameters.
       
    54      *
       
    55      * @since S60 v5.2
       
    56      * @param ap_data Reference to core_ap_data_c from which to generate the information.
       
    57      * @param ie_id_list Information element id list.
       
    58      * @param ie_id_list_length Information element id list length.
       
    59      */
       
    60     static core_frame_rm_ie_beacon_report_frame_body_ie_c* instance(
       
    61         core_ap_data_c& ap_data,
       
    62         u8_t* ie_id_list,
       
    63         u8_t ie_id_list_length );
       
    64 
       
    65     /** 
       
    66      * Destructor.
       
    67      */
       
    68     virtual ~core_frame_rm_ie_beacon_report_frame_body_ie_c();
       
    69     
       
    70     /**
       
    71      * Generate an IE header.
       
    72      *
       
    73      * @param ap_data Reference to core_ap_data_c from which to generate the information.
       
    74      */
       
    75     void generate( core_ap_data_c& ap_data );
       
    76     
       
    77     /**
       
    78      * Generate an IE header.
       
    79      *
       
    80      * @param ap_data Reference to core_ap_data_c from which to generate the information.
       
    81      * @param ie_id_list Information element id list.
       
    82      * @param ie_id_list_length Information element id list length.
       
    83      */
       
    84     void generate( 
       
    85         core_ap_data_c& ap_data,
       
    86         u8_t* ie_id_list,
       
    87         u8_t ie_id_list_length );
       
    88     
       
    89 private:
       
    90 
       
    91     /**
       
    92      * Constructor
       
    93      *
       
    94      * @param data_length Length of the IE data.
       
    95      * @param data Pointer to the IE data.     
       
    96      * @param max_data_length The maximum size of the frame buffer.    
       
    97      */
       
    98     core_frame_rm_ie_beacon_report_frame_body_ie_c(
       
    99        u16_t data_length,
       
   100        const u8_t* data,
       
   101        u16_t max_data_length );
       
   102 
       
   103 private: // data
       
   104 
       
   105     /** Pointer to the start of the current IE data. Not owned by this pointer. */
       
   106     const u8_t* current_ie_m;
       
   107 
       
   108     /** The maximum length of the current IE. */
       
   109     u16_t current_ie_max_length_m;    
       
   110     
       
   111     };
       
   112 
       
   113 #endif // CORE_FRAME_RM_IE_BEACON_REPORT_FRAME_BODY_IE_H
       
   114 
       
   115