qkd-link-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 DOTFEESA www.tk.etf.unsa.ba
 *
 * 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: Miralem Mehic <miralem.mehic@ieee.org>
 */
 
#ifndef QKD_HELPER_H
#define QKD_HELPER_H
 
#include <string>
 
#include "ns3/object-factory.h"
#include "ns3/net-device-container.h"
#include "ns3/node-container.h" 
#include "ns3/trace-helper.h"
#include "ns3/ipv4-interface-address.h"
#include "ns3/core-module.h"  
#include "ns3/network-module.h"
#include "ns3/internet-module.h"  
 
#include "ns3/qkd-encryptor.h"
#include "ns3/qkd-encryptor-container.h"
 
#include "ns3/qkd-control.h"
#include "ns3/qkd-control-container.h"
 
#include "ns3/qkd-graph-manager.h" 
 
namespace ns3 {
 
class NetDevice;
class Node;
 
class QKDLinkHelper 
{
public:
 
    QKDLinkHelper ();
 
    virtual ~QKDLinkHelper () {}
 
    void AddGraph(Ptr<Node> src, Ptr<Node> dst);
 
    void AddGraph(Ptr<Node> src, Ptr<Node> dst, std::string graphName);
    
    void AddGraph(Ptr<Node> src, Ptr<Node> dst, std::string graphName, std::string graphType);
 
    void PrintGraphs(); 
    
    Ptr<QKDEncryptor> InstallQKDEncryptor (Ptr<Node> node);
    
    QKDEncryptorContainer InstallQKDEncryptor (NodeContainer& n);
 
    Ptr<QKDControl> InstallQKDControl (Ptr<Node> node); 
 
    QKDControlContainer InstallQKDControl (NodeContainer& n);  
    
    std::string CreateQKDLink (
        Ptr<QKDControl>         control,
        Ptr<Node>               alice,
        Ptr<Node>               bob, 
        Ptr<Node>               aliceKMS,           
        Ptr<Node>               bobKMS,   
        uint32_t                Mmin,
        uint32_t                Mthr,
        uint32_t                Mmax,
        uint32_t                Mcurrent
    );
 
    bool     m_useRealStorages; 
 
    static void CreateAndAggregateObjectFromTypeId (Ptr<Node> node, const std::string typeId);
 
private:
 
    ObjectFactory m_qkdbufferFactory;        
 
}; 
} // namespace ns3
 
#endif /* QKD_HELPER_H */