User Manual, Developers Guide and API Documentation

Backoff.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_TIMING_BACKOFF_HPP
#define WIMEMAC_LOWERMAC_TIMING_BACKOFF_HPP

#include <WIMEMAC/convergence/IChannelState.hpp>
#include <WIMEMAC/convergence/IRxStartEnd.hpp>

#include <WNS/Observer.hpp>

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

namespace wimemac { namespace lowerMAC { namespace timing {

    class BackoffObserver
    {
    public:
        virtual
        ~BackoffObserver()
        {}

        virtual void backoffExpired() = 0;
    };

    class Backoff :
        public wns::events::CanTimeout,
        public wns::Observer<wimemac::convergence::IChannelState>,
        public wns::Observer<wimemac::convergence::IRxStartEnd>
    {
    public:

        Backoff(BackoffObserver* backoffObserver,
                const wns::pyconfig::View& config);

        ~Backoff();

        bool
        transmissionRequest(int transmissionCounter);

        // observer RxStartEnd
        void
        onRxStart(wns::simulator::Time expRxTime);
        void
        onRxEnd();
        void
        onRxError();

        void
        onChannelBusy();

        void
        onChannelIdle();

        int getCurrentCW() const
        {
            return(cw);
        }

        wns::simulator::Time
        finishedAt() const;

        void
        registerEOBObserver(BackoffObserver * observer);

        void
        OnDRPreservationChange(bool isDRPreservationOn_);
    private:

        void startNewBackoffCountdown(wns::simulator::Time ifsDuration);

        void onTimeout();

        void waitForTimer(const wns::simulator::Time& waitDuration);

        void channelBusyDelay();

        BackoffObserver* backoffObserver;
        std::vector<BackoffObserver*> eobObserver;

        const wns::simulator::Time slotDuration;
        const wns::simulator::Time aifsDuration;
        const wns::simulator::Time eifsDuration;

        bool backoffFinished;
        bool transmissionWaiting;
        bool duringAIFS;
        bool rxError;

        bool isDRPreservationOn;
        bool wasChannelLastSensedBusyDuringDRP;

        const int cwMin;
        const int cwMax;
        int cw;
        wns::distribution::Uniform uniform;
        wns::logger::Logger logger;
        wns::simulator::Time aifsStart;
        bool channelIsBusy;

    protected:
        // For testing purpose this methods and variable is protected and may be
        // set by a special version of the backoff
        int counter;
    };
} // timing
} // lowerMAC
} // wimemac

#endif //  WIMEMAC_SCHEDULER_BACKOFF_HPP

---