User Manual, Developers Guide and API Documentation

TXOP.hpp

Go to the documentation of this file.

/******************************************************************************
 * WiMeMac                                                                    *
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2011
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 5, 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 WIMEMAC_LOWERMAC_TXOP_HPP
#define WIMEMAC_LOWERMAC_TXOP_HPP

#include <WIMEMAC/convergence/PhyUser.hpp>
#include <WIMEMAC/lowerMAC/IManagerServices.hpp>
#include <WIMEMAC/lowerMAC/ITXOPWindow.hpp>
#include <WIMEMAC/lowerMAC/ITXOPObserver.hpp>
#include <WIMEMAC/management/ProtocolCalculator.hpp>

#include <WNS/ldk/fu/Plain.hpp>
#include <WNS/ldk/Processor.hpp>
#include <WNS/ldk/Delayed.hpp>
#include <WNS/ldk/probe/Probe.hpp>

#include <WNS/events/CanTimeout.hpp>
#include <WNS/probe/bus/ContextCollector.hpp>

#include <WNS/Observer.hpp>

namespace wimemac { namespace lowerMAC {
    class TXOP:
        public wns::ldk::fu::Plain<TXOP, wns::ldk::EmptyCommand>,
        public wns::ldk::Processor<TXOP>,
    public wns::ldk::probe::Probe
    {
    public:

        TXOP(wns::ldk::fun::FUN* fun, const wns::pyconfig::View& config);

        virtual
        ~TXOP();

        // observer TxStartEnd
        void
        onTxStart(const wns::ldk::CompoundPtr& compound);
        void
        onTxEnd(const wns::ldk::CompoundPtr& compound);

        void
        registerObserver(wimemac::lowerMAC::ITXOPObserver *observer) {observers.push_back(observer);}

        void closeTXOP(bool forwardCall = true);
        void setTXOPLimit(wns::simulator::Time limit);
    private:
        void processIncoming(const wns::ldk::CompoundPtr& compound);
        void processOutgoing(const wns::ldk::CompoundPtr& compound);

        bool doIsAccepting(const wns::ldk::CompoundPtr& compound) const;

        void onFUNCreated();

        const std::string managerName;
        const std::string protocolCalculatorName;
        const std::string txopWindowName;
        //const std::string raName;

        const wns::simulator::Time sifsDuration;
        const wns::simulator::Time maximumACKDuration;
        const bool singleReceiver;

        bool maxOutTXOP;

        wns::simulator::Time txopLimit;
        wns::simulator::Time remainingTXOPDuration;
        wns::simulator::Time lastFTDuration;
        wns::service::dll::UnicastAddress txopReceiver;

        wns::logger::Logger logger;

        std::vector<wimemac::lowerMAC::ITXOPObserver *> observers;
        wimemac::management::ProtocolCalculator* protocolCalculator;
        struct Friends
        {
            wimemac::lowerMAC::IManagerServices* manager;
            wimemac::lowerMAC::ITXOPWindow* txopWindow;
            //wimemac::lowerMAC::RateAdaptation* ra;
        } friends;

    wns::probe::bus::ContextCollectorPtr TXOPDurationProbe;
    };

} // lowerMAC
} // wimemac

#endif // WIMEMAC_LOWERMAC_TXOP_HPP

---