include/wipal/phy/phy.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 PHY_PHY_HH_
# define PHY_PHY_HH_

# include <wipal/tool/static_base.hh>
# include <wipal/tool/microseconds.hh>
# include <wipal/tool/endianness.hh>
# include <wipal/pcap/pkt.hh>

namespace wpl
{

  // Forward declarations.
  namespace phy
  {
    template <class B>  struct header;
    template <class B>  struct time;
    template <class B>  struct uint64_time;
  }

  // Virtual types.
  namespace tool
  {

    template <class B>
    struct types< phy::time<B> >
    {
      typedef undefined_type    impl_type;
    };

    template <class B>
    struct types< phy::uint64_time<B> >
    {
      typedef uint64_t          impl_type;
    };

    template <class B>
    struct types< phy::header<B> >
    {
      typedef undefined_type    time_type;
    };

  } // End of namespace wpl::tool.


  // Core declarations.
  namespace phy
  {

    /*----------.
    | phy::time |
    `----------*/

    template <class Bottom = tool::bottom>
    struct time: WP_INHERIT(public tool::static_base, time<Bottom>)
    {
      typedef WP_GET_EXACT(Bottom, time<Bottom>)        exact_type;
      typedef WP_TYPE(impl_type, exact_type)            impl_type;

      impl_type get() const;

      exact_type&       operator += (tool::microseconds microseconds);

      exact_type        operator +  (tool::microseconds microseconds) const;

    protected:
      ~time(); // phy::time is abstract!
    };

    /*-----------------.
    | phy::uint64_time |
    `-----------------*/

    template <class Bottom = tool::bottom>
    struct uint64_time: WP_INHERIT(public phy::time, uint64_time<Bottom>)
    {

      typedef WP_GET_EXACT(Bottom, uint64_time<Bottom>) exact_type;
      typedef WP_TYPE(impl_type, exact_type)            impl_type;

      impl_type get_impl() const;
      exact_type&       increment(const tool::microseconds& microseconds);

      uint64_time();

      uint64_time(uint64_t ms_count);

    private:
      uint64_t  ms_count_;
    };

    /*------------.
    | phy::header |
    `------------*/

    template <class Bottom = tool::bottom>
    struct header: WP_INHERIT(public tool::static_base, header<Bottom>)
    {
      typedef WP_GET_EXACT(Bottom, header<Bottom>)      exact_type;
      typedef WP_TYPE(time_type, exact_type)            time_type;

      size_t    len(size_t caplen, bool swapped) const;

      const void*       decapsulate(size_t caplen, bool swapped) const;

      time_type time_get(bool swapped) const;

      void      time_set(const time_type& time, bool swapped);

      template <class S1, class S2>
      static bool
      eq_80211(const pkt::packet<S1>&   lhs,
               const pkt::packet<S2>&   rhs,
               tool::end::endianness    phy_end = tool::end::guess);


      template <class S1, class S2>
      static bool
      eq_time_and_80211(const pkt::packet<S1>&          lhs,
                        const pkt::packet<S2>&          rhs,
                        const unsigned                  precision,
                        const tool::end::endianness     phy_end =
                                                             tool::end::guess);

    protected:
      ~header(); // phy::header is abstract!
    };

  } // End of namespace wpl::phy.

} // End of namespace wpl.

# include "phy.hxx"

#endif // ! PHY_PHY_HH_

---