User Manual, Developers Guide and API Documentation

LinkQualityMeasurement.hpp

Go to the documentation of this file.

/******************************************************************************
 * WiFiMac                                                                    *
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WIFIMAC_PATHSELECTION_LINKQUALITYMEASUREMENT_HPP
#define WIFIMAC_PATHSELECTION_LINKQUALITYMEASUREMENT_HPP

#include <WIFIMAC/pathselection/Metric.hpp>
#include <WIFIMAC/pathselection/PathSelectionInterface.hpp>
#include <WIFIMAC/management/LinkNotificationInterface.hpp>

#include <DLL/UpperConvergence.hpp>

#include <WNS/ldk/Command.hpp>
#include <WNS/ldk/fu/Plain.hpp>

#include <WNS/simulator/Time.hpp>
#include <WNS/events/PeriodicTimeout.hpp>
#include <WNS/events/CanTimeout.hpp>
#include <WNS/logger/Logger.hpp>
#include <WNS/Observer.hpp>
#include <WNS/distribution/Uniform.hpp>
#include <WNS/SlidingWindow.hpp>

namespace wifimac { namespace pathselection {

    class LinkQualityMeasurementCommand :
        public wns::ldk::Command
    {
    public:
        struct {
        } local;

        struct {
            wns::service::dll::UnicastAddress srcMACAddress;
            wns::service::dll::UnicastAddress dstMACAddress;
            wns::simulator::Time txTime;
            wns::simulator::Time lastFrameFlightTime;
        } peer;

        struct {
            bool isPiggybacked;
        } magic;
    };
    
    class LinkQualityMeasurement;
    
    class LinkQuality:
        public wns::events::CanTimeout, 
        public wns::events::PeriodicTimeout
    {
        public:
            LinkQuality(wns::service::dll::UnicastAddress _rx,
                    wns::simulator::Time _referenceFlightTime,
                    wns::simulator::Time _periodicity,
                    LinkQualityMeasurement* _parent);
            
            void receivedLinkQualityIndicator(const LinkQualityMeasurementCommand* lqm);
            
            wns::simulator::Time getLastRxFrameFlightTime() const;
            
            void hasSendPiggybackedLQM();
        private:
            void periodically();
            
            void onTimeout();
            
            const wns::service::dll::UnicastAddress rx;
            
            const wns::simulator::Time referenceFlightTime;
            
            wns::simulator::Time periodicity;
            
            LinkQualityMeasurement* parent;
            
            bool rxLastFrame;
            
            wns::simulator::Time lastRxFrameFlightTime;
            
            wns::SlidingWindow linkCostTx;
            
            Metric oldLinkCostTxAvg;
            
            wns::distribution::Uniform uniform;
    };

    class LinkQualityMeasurement :
        public wns::ldk::fu::Plain<LinkQualityMeasurement, LinkQualityMeasurementCommand>,
        public wns::Observer<wifimac::management::LinkNotificationInterface>
    {
    public:
        LinkQualityMeasurement(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config);
        virtual ~LinkQualityMeasurement();
        
        void sendLinkMeasurement(wns::service::dll::UnicastAddress rx, wns::simulator::Time last);
        
        void newLinkCost(wns::service::dll::UnicastAddress rx, Metric cost);

    private:
        virtual bool doIsAccepting(const wns::ldk::CompoundPtr& _compound) const;
        virtual void doSendData(const wns::ldk::CompoundPtr& _compound);
        virtual void doWakeup();
        virtual void doOnData(const wns::ldk::CompoundPtr& _compound);

        virtual void onFUNCreated();

        void calculateSizes(const wns::ldk::CommandPool* commandPool, Bit& commandPoolSize, Bit& dataSize) const;

        void onLinkIndication(const wns::service::dll::UnicastAddress myself,
                      const wns::service::dll::UnicastAddress peer);
        
        
        const wns::pyconfig::View config;
        const Bit frameSize;
        const wns::simulator::Time referenceFlightTime;
        const wns::simulator::Time period;
        wns::logger::Logger logger;
        const std::string ucName;
        
        const bool doPiggybacking;
        int piggybackingPeriod;
        int numPiggybacked;
        
        PathSelectionInterface* ps;
        
        typedef wns::container::Registry<wns::service::dll::UnicastAddress, LinkQuality*, wns::container::registry::DeleteOnErase> adr2qualityMap;
        adr2qualityMap linkQualities;
        
        wns::service::dll::UnicastAddress myMACAddress;
        struct Friends
        {
            dll::UpperConvergence* uc;
        } friends;
    };

}}

#endif

---