ipv4-routing-helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 INRIA
 *
 * 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
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
 
#ifndef IPV4_ROUTING_HELPER_H
#define IPV4_ROUTING_HELPER_H
 
#include "ns3/ipv4-list-routing.h"
#include "ns3/nstime.h"
#include "ns3/output-stream-wrapper.h"
#include "ns3/ptr.h"
 
namespace ns3
{
 
class Ipv4RoutingProtocol;
class Node;
 
class Ipv4RoutingHelper
{
  public:
    /*
     * Destroy an instance of an Ipv4RoutingHelper
     */
    virtual ~Ipv4RoutingHelper();
 
    virtual Ipv4RoutingHelper* Copy() const = 0;
 
    virtual Ptr<Ipv4RoutingProtocol> Create(Ptr<Node> node) const = 0;
 
    static void PrintRoutingTableAllAt(Time printTime,
                                       Ptr<OutputStreamWrapper> stream,
                                       Time::Unit unit = Time::S);
 
    static void PrintRoutingTableAllEvery(Time printInterval,
                                          Ptr<OutputStreamWrapper> stream,
                                          Time::Unit unit = Time::S);
 
    static void PrintRoutingTableAt(Time printTime,
                                    Ptr<Node> node,
                                    Ptr<OutputStreamWrapper> stream,
                                    Time::Unit unit = Time::S);
 
    static void PrintRoutingTableEvery(Time printInterval,
                                       Ptr<Node> node,
                                       Ptr<OutputStreamWrapper> stream,
                                       Time::Unit unit = Time::S);
 
    static void PrintNeighborCacheAllAt(Time printTime,
                                        Ptr<OutputStreamWrapper> stream,
                                        Time::Unit unit = Time::S);
 
    static void PrintNeighborCacheAllEvery(Time printInterval,
                                           Ptr<OutputStreamWrapper> stream,
                                           Time::Unit unit = Time::S);
 
    static void PrintNeighborCacheAt(Time printTime,
                                     Ptr<Node> node,
                                     Ptr<OutputStreamWrapper> stream,
                                     Time::Unit unit = Time::S);
 
    static void PrintNeighborCacheEvery(Time printInterval,
                                        Ptr<Node> node,
                                        Ptr<OutputStreamWrapper> stream,
                                        Time::Unit unit = Time::S);
 
    template <class T>
    static Ptr<T> GetRouting(Ptr<Ipv4RoutingProtocol> protocol);
 
  private:
    static void Print(Ptr<Node> node, Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S);
 
    static void PrintEvery(Time printInterval,
                           Ptr<Node> node,
                           Ptr<OutputStreamWrapper> stream,
                           Time::Unit unit = Time::S);
 
    static void PrintArpCache(Ptr<Node> node,
                              Ptr<OutputStreamWrapper> stream,
                              Time::Unit unit = Time::S);
 
    static void PrintArpCacheEvery(Time printInterval,
                                   Ptr<Node> node,
                                   Ptr<OutputStreamWrapper> stream,
                                   Time::Unit unit = Time::S);
};
 
template <class T>
Ptr<T>
Ipv4RoutingHelper::GetRouting(Ptr<Ipv4RoutingProtocol> protocol)
{
    Ptr<T> ret = DynamicCast<T>(protocol);
    if (!ret)
    {
        // trying to check if protocol is a list routing
        Ptr<Ipv4ListRouting> lrp = DynamicCast<Ipv4ListRouting>(protocol);
        if (lrp)
        {
            for (uint32_t i = 0; i < lrp->GetNRoutingProtocols(); i++)
            {
                int16_t priority;
                ret = GetRouting<T>(lrp->GetRoutingProtocol(
                    i,
                    priority)); // potential recursion, if inside ListRouting is ListRouting
                if (ret)
                {
                    break;
                }
            }
        }
    }
 
    return ret;
}
 
} // namespace ns3
 
#endif /* IPV4_ROUTING_HELPER_H */