wlan_bearer/wlanengine/wlan_common/wlanengine_common_3.1/inc/core_frame_assoc_resp.h
changeset 0 c40eb8fe8501
equal deleted inserted replaced
-1:000000000000 0:c40eb8fe8501
       
     1 /*
       
     2 * Copyright (c) 2005-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:  Parser utility for 802.11 (re-)association response frames.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CORE_FRAME_ASSOC_RESP_H
       
    20 #define CORE_FRAME_ASSOC_RESP_H
       
    21 
       
    22 #include "am_platform_libraries.h"
       
    23 #include "core_types.h"
       
    24 #include "core_frame_dot11.h"
       
    25 
       
    26 /**
       
    27  * Class for parsing 802.11 (re-)association response frames.
       
    28  *
       
    29  * @lib wlmserversrv.lib
       
    30  * @since S60 v3.1
       
    31  */
       
    32 NONSHARABLE_CLASS( core_frame_assoc_resp_c ) : public core_frame_dot11_c
       
    33     {
       
    34 
       
    35 public:
       
    36 
       
    37     /**
       
    38      * Factory for creating a parser for the given frame.
       
    39      *
       
    40      * @since S60 v3.1
       
    41      * @param frame Frame to be parsed.
       
    42      * @param is_copied Whether the object should take a copy of the frame data.    
       
    43      * @return Pointer to the created parser instance.
       
    44      */
       
    45     static core_frame_assoc_resp_c* instance(
       
    46         const core_frame_dot11_c& frame,
       
    47         bool_t is_copied = false_t );
       
    48 
       
    49     /**
       
    50      * Destructor.
       
    51      */
       
    52     virtual ~core_frame_assoc_resp_c();
       
    53 
       
    54     /**
       
    55      * Return the Capability field of the frame.
       
    56      * 
       
    57      * @since S60 v3.1
       
    58      * @return The Capability field of the frame.     
       
    59      */    
       
    60     u16_t capability() const;
       
    61 
       
    62     /**
       
    63      * Return the Status Code field of the frame.
       
    64      *
       
    65      * @since S60 v3.1
       
    66      * @return The Status Code field of the frame.
       
    67      */
       
    68     u16_t status_code() const;
       
    69 
       
    70     /**
       
    71      * Return the AID field of the frame.
       
    72      * 
       
    73      * @since S60 v3.1
       
    74      * @return The AID field of the frame.     
       
    75      */    
       
    76     u16_t aid() const;
       
    77 
       
    78 private:
       
    79 
       
    80     /**
       
    81      * Return the offset of the first IE.
       
    82      * @return The offset of the first IE. 0 if the frame doesn't support IEs.
       
    83      */
       
    84     u16_t first_ie_offset() const;
       
    85 
       
    86     /**
       
    87      * Constructor.
       
    88      * 
       
    89      * @param data_length Length of the frame.
       
    90      * @param data Pointer to the frame data.
       
    91      * @param max_data_length The maximum size of the frame buffer. 
       
    92      */
       
    93     core_frame_assoc_resp_c(
       
    94         u16_t data_length,
       
    95         const u8_t* data,
       
    96         u16_t max_data_length );
       
    97     };
       
    98 
       
    99 #endif // CORE_FRAME_ASSOC_RESP_H