include/wipal/wifi/frame.hh

/*
 * WiPal - A library and a set of tools to manipulate wireless traces.
 * Copyright (C) 2007, 2008, 2009  Universite Pierre et Marie Curie - Paris 6
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301  USA
 *
 * Author: Thomas Claveirole <thomas.claveirole@lip6.fr>
 */
#ifndef WIFI_FRAME_FRAME_HH_
# define WIFI_FRAME_FRAME_HH_

# include <string>

extern "C"
{
# include <stdint.h>
}

# include <boost/optional.hpp>

# include <wipal/wifi/addr.hh>

namespace wpl
{

  namespace wifi
  {

    namespace type
    {

      enum frame_type
        {
          management            = 0,    
          control               = 1,    
          data                  = 2,    
          reserved              = 3     
        };

      extern const std::string  names[4];

    } // End of namespace wpl::wifi::type.


    namespace subtype
    {

      extern const std::string* const   names[4];

    } // End of namespace wpl::wifi::subtype.

    /*---------------.
    | Control fields |
    `---------------*/

    unsigned
    protocol_version_of(const void*);

    type::frame_type
    type_of(const void*);

    unsigned
    subtype_of(const void*);

    uint8_t
    control_flags_of(const void*);

    /*--------------.
    | Control flags |
    `--------------*/

    bool
    control_flag(const unsigned flag, const void* frame);

    bool
    to_ds(const void*);

    bool
    from_ds(const void*);

    /*---------.
    | Duration |
    `---------*/

    unsigned
    duration_of(const void*);

    /*-----------------.
    | Sequence control |
    `-----------------*/

    boost::optional<unsigned>
    fragment_number_of(const void*, size_t caplen);

    boost::optional<unsigned>
    sequence_number_of(const void*, size_t caplen);

    /*------------------.
    | Misc. information |
    `------------------*/

    const addr*
    transmitter_address(const void* frame);

    const addr*
    bssid_address(const void*, size_t caplen = 30);

  } // End of namespace wpl::wifi.

} // End of namespace wpl.

# include "frame.hxx"

#endif // ! WIFI_FRAME_FRAME_HH_

---