include/wipal/pcap/pkt.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 PCAP_PKT_HH_
# define PCAP_PKT_HH_

extern "C"
{
# include <time.h>
# include <inttypes.h>
}
# include <iostream>

# include <boost/shared_ptr.hpp>
# include <boost/array.hpp>

# include <wipal/tool/iterable.hh>
# include <wipal/tool/options.hh>

namespace wpl
{

  namespace pkt
  {

    enum type
      {
        LOOP                    = 0,    
        EN10MB                  = 1,    
        EN3MB                   = 2,    
        AX25                    = 3,    
        PRONET                  = 4,    
        CHAOS                   = 5,    
        IEEE802                 = 6,    
        ARCNET                  = 7,    
        SLIP                    = 8,    
        PPP                     = 9,    
        FDDI                    = 10,   
        IEEE802_11              = 105,  
        PRISM_HEADER            = 119,  
        IEEE802_11_RADIO        = 127,  
        IEEE802_11_RADIO_AVS    = 163   
      };

    struct metadata
    {
      metadata(unsigned id,
               unsigned ts_sec,
               unsigned ts_usec,
               size_t   caplen,
               size_t   len);

      bool operator == (const metadata&) const; // Does not check id.
      bool operator != (const metadata&) const;

      unsigned          id;     
      struct timeval    ts;     
      size_t            caplen; 
      size_t            len;    
    };

    template <class Bottom>
    struct stream: WP_INHERIT(public tool::iterable, stream<Bottom>)
    {
      typedef WP_GET_EXACT(Bottom, stream<Bottom>)      exact_type;
      typedef tool::iterable<exact_type>                super_type;
      typedef WP_TYPE(iterator, exact_type)             iterator;
      typedef iterator                                  const_iterator;
      typedef typename iterator::value_type             packet;

      bool              swapped() const;

      pkt::type         type() const;

      void              expect(pkt::type t) const;

      std::ostream&     print(std::ostream&) const;

      std::ostream&     print_impl(std::ostream&) const;

      opt::list&        meta();
      const opt::list&  meta() const;

    private:
      opt::list         meta_;
    };

    template <class B>
    std::ostream&
    operator << (std::ostream& os, const stream<B>& s);

    template <class Source>
    struct packet
    {
      enum { max_size = 65535 };

      typedef Source            source_type;


      packet(unsigned           index,
             unsigned           sec,
             unsigned           usec,
             size_t             caplen,
             size_t             len = 0,
             const Source*      src = 0);

      packet(const metadata&    meta,
             const Source*      src = 0);

      const Source*     source_ptr() const;

      const Source&     source() const;

      bool              swapped() const;

      long              use_count() const;

      bool              unique() const;


      const metadata&   meta() const;
      metadata&         meta();


      const void*       bytes() const;
      void*             bytes();

      std::ostream&     print(std::ostream&) const;


      bool      operator == (const packet&) const;
      bool      operator != (const packet&) const;

      struct shared_data
      {
        template <class B>
        shared_data(const stream<B>*    src,
                    const metadata&     meta);

        const Source*                   src_;
        metadata                        meta_;
        boost::array<uint8_t, max_size> bytes_;
      };

    protected:
      boost::shared_ptr<shared_data>            data_;
    };

    template <class Source>
    std::ostream&
    operator << (std::ostream&, const packet<Source>&);

  } // End of namespace wpl::pkt.

} // End of namespace wpl.

# include "pkt.hxx"

#endif // ! PCAP_PKT_HH_

---