ipv4-route.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 University of Washington
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#ifndef IPV4_ROUTE_H
#define IPV4_ROUTE_H

#include <list>
#include <map>
#include <ostream>

#include "ns3/simple-ref-count.h"
#include "ns3/ipv4-address.h"
#include "ns3/deprecated.h"

namespace ns3 {

class NetDevice;

class Ipv4Route : public SimpleRefCount<Ipv4Route> 
{
public:
  Ipv4Route ();

  void SetDestination (Ipv4Address dest);
  Ipv4Address GetDestination (void) const;

  void SetSource (Ipv4Address src);
  Ipv4Address GetSource (void) const;

  void SetGateway (Ipv4Address gw);
  Ipv4Address GetGateway (void) const;

  void SetOutputDevice (Ptr<NetDevice> outputDevice);
  Ptr<NetDevice> GetOutputDevice (void) const;

#ifdef NOTYET
  // rtable.idev
  void SetInputIfIndex (uint32_t iif);
  uint32_t GetInputIfIndex (void) const;
#endif

private:
  Ipv4Address m_dest;
  Ipv4Address m_source;
  Ipv4Address m_gateway;
  Ptr<NetDevice> m_outputDevice;
#ifdef NOTYET
  uint32_t m_inputIfIndex;
#endif
};

std::ostream& operator<< (std::ostream& os, Ipv4Route const& route);

class Ipv4MulticastRoute : public SimpleRefCount<Ipv4MulticastRoute> 
{
public:
  Ipv4MulticastRoute ();

  void SetGroup (const Ipv4Address group);
  Ipv4Address GetGroup (void) const; 

  void SetOrigin (const Ipv4Address origin);
  Ipv4Address GetOrigin (void) const; 

  void SetParent (uint32_t iif);
  uint32_t GetParent (void) const;

  void SetOutputTtl (uint32_t oif, uint32_t ttl);
  uint32_t GetOutputTtl (uint32_t oif) NS_DEPRECATED;

  std::map<uint32_t, uint32_t> GetOutputTtlMap () const;

  static const uint32_t MAX_INTERFACES = 16;  // Maximum number of multicast interfaces on a router
  static const uint32_t MAX_TTL = 255;  // Maximum time-to-live (TTL)

private:
  Ipv4Address m_group;      // Group 
  Ipv4Address m_origin;     // Source of packet
  uint32_t m_parent;        // Source interface
  std::map<uint32_t, uint32_t> m_ttls;
};

} // namespace ns3

#endif /* IPV4_ROUTE_H */