ofswitch13-helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 University of Campinas (Unicamp)
 *
 * 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: Luciano Jerez Chaves <ljerezchaves@gmail.com>
 */
 
#ifndef OFSWITCH13_HELPER_H
#define OFSWITCH13_HELPER_H
 
#include <ns3/application-container.h>
#include <ns3/csma-helper.h>
#include <ns3/inet-socket-address.h>
#include <ns3/internet-stack-helper.h>
#include <ns3/ipv4-address-helper.h>
#include <ns3/ipv4-interface-container.h>
#include <ns3/names.h>
#include <ns3/node-container.h>
#include <ns3/object-factory.h>
#include <ns3/ofswitch13-controller.h>
#include <ns3/ofswitch13-device-container.h>
#include <ns3/ofswitch13-device.h>
#include <ns3/ofswitch13-interface.h>
#include <ns3/point-to-point-helper.h>
#include <ns3/simple-ref-count.h>
 
#include <string>
 
namespace ns3
{
 
class Node;
class AttributeValue;
class OFSwitch13Controller;
class OFSwitch13LearningController;
 
class OFSwitch13Helper : public Object
{
  public:
    enum ChannelType
    {
        SINGLECSMA = 0,    
        DEDICATEDCSMA = 1, 
        DEDICATEDP2P = 2   
    };
 
    OFSwitch13Helper();           
    ~OFSwitch13Helper() override; 
 
    static TypeId GetTypeId();
 
    void SetDeviceAttribute(std::string n1, const AttributeValue& v1);
 
    virtual void SetChannelType(ChannelType type);
 
    virtual void SetChannelDataRate(DataRate rate);
 
    void EnableOpenFlowPcap(std::string prefix = "ofchannel",
                            bool promiscuous = true);
 
    void EnableOpenFlowAscii(std::string prefix = "ofchannel");
 
    void EnableDatapathStats(std::string prefix = "datapath",
                             bool useNodeNames = false);
 
    Ptr<OFSwitch13Device> InstallSwitch(Ptr<Node> swNode,
                                        NetDeviceContainer& swPorts);
 
    Ptr<OFSwitch13Device> InstallSwitch(Ptr<Node> swNode);
 
    OFSwitch13DeviceContainer InstallSwitch(NodeContainer& swNodes);
 
    virtual void CreateOpenFlowChannels() = 0;
 
    static void SetAddressBase(Ipv4Address network,
                               Ipv4Mask mask,
                               Ipv4Address base = "0.0.0.1");
 
    static void EnableDatapathLogs(std::string prefix = "",
                                   bool explicitFilename = false);
 
  protected:
    void DoDispose() override;
 
    ChannelType m_channelType;  
    DataRate m_channelDataRate; 
    ObjectFactory m_devFactory; 
    bool m_blocked;             
 
    NetDeviceContainer m_controlDevs;         
    OFSwitch13DeviceContainer m_openFlowDevs; 
    NodeContainer m_switchNodes;              
 
    InternetStackHelper m_internet; 
    CsmaHelper m_csmaHelper;        
    PointToPointHelper m_p2pHelper; 
 
    static Ipv4AddressHelper m_ipv4helper; 
};
 
} // namespace ns3
#endif /* OFSWITCH1_CONTROLLER_HELPER_H */