include/wipal/wifi/dissector/default_hooks.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_DISSECTOR_DEFAULT_HOOKS_HH_
# define WIFI_DISSECTOR_DEFAULT_HOOKS_HH_

# include <wipal/wifi/mgt.hh>
# include <wipal/wifi/ctl.hh>
# include <wipal/wifi/data.hh>
# include <wipal/wifi/dissector/status.hh>

namespace wpl
{

  namespace wifi
  {
    struct dissector_default_hooks
    {
      typedef dissector_status::status  status;

    protected:

      //        ******************* //
      //        ******************* //

      void      invalid_type_or_subtype_hook(const void*, size_t, status);
      void      invalid_type_hook(const void*, size_t);
      void      invalid_subtype_hook(const void*, size_t, status);
      void      invalid_management_subtype_hook(const mgt::header*, size_t);
      void      invalid_control_subtype_hook(const void*, size_t);
      void      invalid_data_subtype_hook(const void*, size_t, status);



      //        *********** //
      //        *********** //


      void      frame_hook(const void*, size_t);

      void      addr_hook(const void*, size_t, unsigned, const addr&);

      void      seq_ctl_hook(const void*, size_t,
                             unsigned   frag,
                             unsigned   seqno);

      void      qos_ctl_hook(const void*, size_t,
                             unsigned   tid,
                             bool       eosp,
                             unsigned   ackpolicy,
                             unsigned   lastfield);

      void      end_of_frame_headers_hook(const void*, size_t, const void*);

      void      end_of_frame_hook(const void*, size_t, status);

      void      management_hook(const mgt::header*, size_t);

      void      control_hook(const void*, size_t);

      void      data_hook(const void*, size_t);



      //        *************** //
      //        *************** //

      void      truncated_frame_hook(const void*, size_t, status);
      void      truncated_unknown_frame_hook(const void*, size_t);
      void      truncated_management_frame_hook(const mgt::header*, size_t,
                                                status);
      void      truncated_ps_poll_frame_hook(const ctl::ps_poll::header*,
                                             size_t, status);
      void      truncated_rts_frame_hook(const ctl::rts::header*, size_t,
                                         status);
      void      truncated_cf_end_frame_hook(const ctl::cf_end::header*, size_t,
                                            status);
      void      truncated_cf_end_cf_ack_frame_hook(const ctl::cf_end_cf_ack::
                                                   header*, size_t, status);
      void      truncated_cts_frame_hook(const ctl::cts::header*, size_t);
      void      truncated_ack_frame_hook(const ctl::ack::header*, size_t);
      void      truncated_data_frame_hook(const void*, size_t, status);

      // @}

      //        ********************** //
      //        ********************** //

      // Field hooks.
      void      management_addr1_hook(const mgt::header*, size_t);
      void      management_addr2_hook(const mgt::header*, size_t);
      void      management_addr3_hook(const mgt::header*, size_t);
      void      management_seq_ctl_hook(const mgt::header*, size_t,
                                        unsigned, unsigned);

      // Inidividual frame subtypes.
      void      beacon_hook(const mgt::header*, size_t);
      void      assoc_req_hook(const mgt::header*, size_t);
      void      assoc_resp_hook(const mgt::header*, size_t);
      void      reassoc_req_hook(const mgt::header*, size_t);
      void      reassoc_resp_hook(const mgt::header*, size_t);
      void      probe_req_hook(const mgt::header*, size_t);
      void      probe_resp_hook(const mgt::header*, size_t);
      void      atim_hook(const mgt::header*, size_t);
      void      disassoc_hook(const mgt::header*, size_t);
      void      auth_hook(const mgt::header*, size_t);
      void      deauth_hook(const mgt::header*, size_t);



      //        ******************* //
      //        ******************* //

      // Individual frame subtypes.
      void      ps_poll_hook(const ctl::ps_poll::header*, size_t);
      void      rts_hook(const ctl::rts::header*, size_t);
      void      cf_end_hook(const ctl::cf_end::header*, size_t);
      void      cf_end_cf_ack_hook(const ctl::cf_end_cf_ack::header*, size_t);
      void      cts_hook(const ctl::cts::header*, size_t);
      void      ack_hook(const ctl::ack::header*, size_t);

      // Field hooks //

      // PS Poll.
      void      ps_poll_addr1_hook(const ctl::ps_poll::header*, size_t);
      void      ps_poll_addr2_hook(const ctl::ps_poll::header*, size_t);

      // RTS.
      void      rts_addr1_hook(const ctl::rts::header*, size_t);
      void      rts_addr2_hook(const ctl::rts::header*, size_t);

      // CF-End.
      void      cf_end_addr1_hook(const ctl::cf_end::header*, size_t);
      void      cf_end_addr2_hook(const ctl::cf_end::header*, size_t);

      // CF-End + CF-Ack.
      void cf_end_cf_ack_addr1_hook(const ctl::cf_end_cf_ack::header*, size_t);
      void cf_end_cf_ack_addr2_hook(const ctl::cf_end_cf_ack::header*, size_t);

      // CTS.
      void      cts_addr1_hook(const ctl::cts::header*, size_t);

      // Ack.
      void      ack_addr1_hook(const ctl::ack::header*, size_t);


      //        **************** //
      //        **************** //

      // Field hooks.
      void      data_addr1_hook(const void*, size_t);
      void      data_addr2_hook(const void*, size_t);
      void      data_addr3_hook(const void*, size_t);
      void      data_addr4_hook(const void*, size_t);
      void      data_seq_ctl_hook(const void*, size_t, unsigned, unsigned);

      // Individual frame subtypes.
      void      data_only_hook(const void*, size_t, status);
      void      data_cf_ack_hook(const void*, size_t, status);
      void      data_cf_poll_hook(const void*, size_t, status);
      void      data_cf_ack_cf_poll_hook(const void*, size_t, status);
      void      null_hook(const void*, size_t, status);
      void      cf_ack_hook(const void*, size_t, status);
      void      cf_poll_hook(const void*, size_t, status);
      void      cf_ack_cf_poll_hook(const void*, size_t, status);

      void      within_ibss_hook(const data::within_ibss::header*, size_t);
      void      from_ds_hook(const data::from_ds::header*, size_t);
      void      to_ds_hook(const data::to_ds::header*, size_t);
      void      ap_to_ap_hook(const data::ap_to_ap::header*, size_t);


    };

  } // End of namespace wpl::wifi.

} // End of namespace wpl.

# include "default_hooks.hxx"

#endif // ! WIFI_DISSECTOR_DEFAULT_HOOKS_HH_

---