diff -r 000000000000 -r c40eb8fe8501 wlan_bearer/wlanengine/wlan_common/wlanengine_common_3.1/inc/core_frame_action_rm.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/wlan_bearer/wlanengine/wlan_common/wlanengine_common_3.1/inc/core_frame_action_rm.h Tue Feb 02 02:03:13 2010 +0200 @@ -0,0 +1,155 @@ +/* +* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). +* All rights reserved. +* This component and the accompanying materials are made available +* under the terms of the License "Eclipse Public License v1.0" +* which accompanies this distribution, and is available +* at the URL "http://www.eclipse.org/legal/epl-v10.html". +* +* Initial Contributors: +* Nokia Corporation - initial contribution. +* +* Contributors: +* +* Description: Class for parsing and generating 802.11 action frames in RM category. +* +*/ + + +#ifndef CORE_FRAME_ACTION_RM_H +#define CORE_FRAME_ACTION_RM_H + +#include "am_platform_libraries.h" +#include "core_types.h" +#include "core_frame_action.h" + +class core_frame_rm_ie_c; + +/** + * Class for parsing and generating 802.11 action frames in RM category. + * + * @lib wlmserversrv.lib + * @since S60 v5.2 + */ +NONSHARABLE_CLASS( core_frame_action_rm_c ) : public core_frame_action_c + { + +public: + + /** + * Defines the possible Type values. + */ + enum core_dot11_action_rm_type_e + { + core_dot11_action_rm_type_meas_req = 0, + core_dot11_action_rm_type_meas_resp = 1, + core_dot11_action_rm_type_neighbor_req = 4, + core_dot11_action_rm_type_neighbor_resp = 5 + }; + + /** + * Factory for creating a parser for the given frame. + * + * @since S60 v5.2 + * @param frame Frame to be parsed. + * @param is_copied Frame is copied. + * @return Pointer to the created parser instance. + */ + static core_frame_action_rm_c* instance( + const core_frame_action_c& frame, + bool_t is_copied ); + + /** + * Generate a 802.11 action frame in RM category. + * + * @since S60 v5.2 + * @param duration The Duration field of the frame. + * @param destination The destination MAC field of the frame. + * @param source The source MAC field of the frame. + * @param bssid The BSSID field of the frame. + * @param sequence_control The Sequence Control field of the frame. + * @param action_type Action Type field of the frame. + * @param dialog_token The Dialog Token field of the frame. + * @param rm_ie Reference to the RM information element of the frame + * @return Pointer to the created frame instance. + */ + static core_frame_action_rm_c* instance( + u16_t duration, + const core_mac_address_s& destination, + const core_mac_address_s& source, + const core_mac_address_s& bssid, + u16_t sequence_control, + u8_t action_type, + u8_t dialog_token, + const core_frame_rm_ie_c* rm_ie ); + + /** + * Destructor. + * + * @since S60 v5.2 + */ + virtual ~core_frame_action_rm_c(); + + /** + * Return the Dialog Token field of the header. + * + * @since S60 v5.2 + */ + u8_t dialog_token() const; + + /** + * Return the Number of Repetitions field of the header. + * + * @since S60 v5.2 + */ + u16_t nbr_of_repetitions() const; + +private: + + /** + * Return the offset of the first IE. + * @return The offset of the first IE. 0 if the frame doesn't support IEs. + * + * @since S60 v5.2 + */ + u16_t first_ie_offset() const; + + /** + * Generate a 802.11 RM request frame. + * + * @since S60 v5.2 + * @param duration The Duration field of the frame. + * @param destination The destination MAC field of the frame. + * @param source The source MAC field of the frame. + * @param bssid The BSSID field of the frame. + * @param sequence_control The Sequence Control field of the frame. + * @param action_type Action Type field of the frame. + * @param dialog_token The Dialog Token field of the frame. + * @param rm_ie The RM element of the frame. + */ + void generate( + u16_t duration, + const core_mac_address_s& destination, + const core_mac_address_s& source, + const core_mac_address_s& bssid, + u16_t sequence_control, + u8_t action_type, + u8_t dialog_token, + const core_frame_rm_ie_c* rm_ie ); + + /** + * Constructor. + * + * @since S60 v5.2 + * @param data_length Length of the frame. + * @param data Pointer to the frame data. + * @param max_data_length The maximum size of the frame buffer. + */ + core_frame_action_rm_c( + u16_t data_length, + const u8_t* data, + u16_t max_data_length ); + + }; + +#endif // CORE_FRAME_ACTION_RM_H