qkd-control.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 QKDCONTROL_H
#define QKDCONTROL_H
 
#include <queue>
#include <vector>
#include <map>
#include <string>
 
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/ipv4-header.h" 
#include "ns3/traced-value.h"
#include "ns3/trace-source-accessor.h"
#include "ns3/event-id.h"
#include "ns3/node.h" 
#include "ns3/ptr.h"
#include "ns3/vector.h"
 
#include "ns3/names.h"
#include "ns3/tag.h"
#include "ns3/net-device.h"
#include "ns3/traffic-control-layer.h"
 
#include "ns3/qkd-encryptor.h"
#include "ns3/qkd-buffer.h"  
 
#include "ns3/object-factory.h"
#include "ns3/core-module.h"  
#include "ns3/network-module.h"
#include "ns3/internet-module.h"
#include "ns3/ipv4-interface-address.h"
 
#include "ns3/applications-module.h"
#include "ns3/qkd-key-manager-system-application.h"
 
namespace ns3 {
 
    class Node; 
    class QKDControl : public Object 
    {
    public:
 
        struct QKDLink
        {
            Ptr<Node>               alice;
            Ptr<Node>               bob;
            Ptr<QKDBuffer>          qkdBufferAlice;
            Ptr<QKDBuffer>          qkdBufferBob;
            double                  publicChannelMetric;
            double                  quantumChannelMetric;
            std::string             keyAssociationId;
        };
 
        static TypeId GetTypeId (void);
 
        virtual TypeId GetInstanceTypeId (void) const;
       
        QKDControl ();
 
        virtual ~QKDControl ();
            
        void Dispose(void);
 
        uint32_t GetNQKDBuffers (void) const;
         
        struct QKDControl::QKDLink AddNewLink (  
            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                    isMaster,
            bool                    useRealStorages
        );  
 
        void AddLinkRecord (struct QKDControl::QKDLink); 
 
        Ptr<QKDBuffer> GetBufferByDestinationNode (Ptr<Node>);
 
        Ptr<QKDBuffer> GetBufferByPosition (const uint32_t& bufferPosition);
 
        Ptr<Node> GetNode();
        
        void SetNode (Ptr<Node>);
 
        std::vector<std::string> RegisterQKDApplications (
            Ptr<QKDApp004> alice, 
            Ptr<QKDApp004> bob,
            Ptr<QKDKeyManagerSystemApplication> kmsA,
            Ptr<QKDKeyManagerSystemApplication> kmsB
        );
        
        std::vector<std::string> RegisterQKDApplications (
            Ptr<QKDApp014> alice, 
            Ptr<QKDApp014> bob,
            Ptr<QKDKeyManagerSystemApplication> kmsA,
            Ptr<QKDKeyManagerSystemApplication> kmsB
        );
 
    protected: 
        virtual void DoDispose (void);
 
        virtual void DoInitialize (void);
 
    private:  
 
        Ptr<Node> m_node; 
 
        std::vector<Ptr<QKDBuffer> > m_qkdbuffers; 
        
        std::map<uint32_t, QKDLink> m_destinations; //<! The map of QKD destinations including buffers.
 
    }; 
}  
// namespace ns3
 
#endif /* QKDCONTROL_H */