metricflood.hh

COPE the first practical network coding scheme which is developped on click

#ifndef CLICK_MetricFlood_HH
#define CLICK_MetricFlood_HH
#include <click/element.hh>
#include <click/glue.hh>
#include <click/timer.hh>
#include <click/ipaddress.hh>
#include <click/etheraddress.hh>
#include <click/vector.hh>
#include <click/hashmap.hh>
#include <click/dequeue.hh>
#include <elements/wifi/linktable.hh>
#include <elements/wifi/arptable.hh>
#include <elements/wifi/sr/path.hh>
#include "metricflood.hh"
#include <elements/wifi/rxstats.hh>
CLICK_DECLS

/*
=c
MetricFlood(IP, ETH, ETHERTYPE, MetricFlood element, LinkTable element, ARPtable element, 
   [METRIC GridGenericMetric], [WARMUP period in seconds])

=s Wifi, Wireless Routing

Floods a packet with previous hops based on Link Metrics.


 */


class MetricFlood : public Element {
 public:
  
  MetricFlood();
  ~MetricFlood();
  
  const char *class_name() const		{ return "MetricFlood"; }
  const char *processing() const		{ return PUSH; }
  const char *flow_code() const			{ return "#/#"; }
  int initialize(ErrorHandler *);
  int configure(Vector<String> &conf, ErrorHandler *errh);


  /* handler stuff */
  void add_handlers();

  void push(int, Packet *);

  bool update_link(IPAddress from, IPAddress to, 
		   uint32_t seq, uint32_t age,		   
		   uint32_t metric);
  void forward_query_hook();
  IPAddress get_random_neighbor();


  // List of query sequence #s that we've already seen.
  class Seen {
  public:
    IPAddress _src;
    IPAddress _dst;
    u_long _seq;
    Packet *_p;
    int _count;
    Timestamp _when; /* when we saw the first query */
    Timestamp _to_send;
    bool _forwarded;


    Seen(IPAddress src, IPAddress dst, u_long seq, int, int) {
      _src = src; 
      _dst = dst; 
      _seq = seq; 
      _count = 0;
      _p = 0;
    }
    Seen() {
      _p = 0;
    }
  };

  typedef HashMap<IPAddress, bool> IPMap;
  IPMap _neighbors;
  Vector<IPAddress> _neighbors_v;

  DEQueue<Seen> _seen;

  int MaxSeen;   // Max size of table of already-seen queries.
  int MaxHops;   // Max hop count for queries.
  struct timeval _query_wait;
  u_long _seq;      // Next query sequence number to use.
  IPAddress _ip;    // My IP address.
  EtherAddress _en; // My ethernet address.
  uint32_t _et;     // This protocol's ethertype

  IPAddress _bcast_ip;

  EtherAddress _bcast;

  class LinkTable *_link_table;
  class ARPTable *_arp_table;

  bool _debug;

  void start_flood(Packet *p_in);
  void  process_flood(Packet *p_in);
  void forward_query(Seen *s);
  static void static_forward_query_hook(Timer *, void *e) { 
    ((MetricFlood *) e)->forward_query_hook(); 
  }
};


CLICK_ENDDECLS
#endif