User Manual, Developers Guide and API Documentation

SelectiveRepeat.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * 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 WNS_LDK_ARQ_SELECTIVEREPEAT_HPP
#define WNS_LDK_ARQ_SELECTIVEREPEAT_HPP

#include <WNS/pyconfig/View.hpp>

#include <WNS/ldk/arq/ARQ.hpp>
#include <WNS/ldk/Delayed.hpp>
#include <WNS/ldk/SuspendableInterface.hpp>
#include <WNS/ldk/SuspendSupport.hpp>
#include <WNS/ldk/DelayedDeliveryInterface.hpp>
#include <WNS/ldk/fu/Plain.hpp>

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

#include <list>
#include <cmath>

namespace wns { namespace ldk { namespace arq {

    namespace tests {
        class SelectiveRepeatTest;
    }

    class SelectiveRepeatCommand :
        public ARQCommand
    {
    public:
        /*
         * I - Information Frame
         * ACK - received Packet (ACK)
         */
        typedef enum {I, ACK} FrameType;

        SelectiveRepeatCommand()
        {
            peer.type = I;
            peer.ns = 0;
            local.lastSentTime = 0.0;
            local.firstSentTime = 0.0;
            magic.ackSentTime = 0.0;
        }

        void setNS(SequenceNumber sn)
        {
            peer.ns = sn;
        }

        SequenceNumber getNS() const
        {
            return peer.ns;
        }

        bool isACK() const
        {
            return peer.type == ACK;
        }

        struct {
            simTimeType lastSentTime;
            simTimeType firstSentTime;
        } local;
        struct {
            FrameType type;
            SequenceNumber ns;
        } peer;
        struct {
            simTimeType ackSentTime;
        } magic;
    };


    class SelectiveRepeat :
        public ARQ,
        public wns::ldk::fu::Plain<SelectiveRepeat, SelectiveRepeatCommand>,
        public Delayed<SelectiveRepeat>,
        virtual public SuspendableInterface,
        public SuspendSupport,
        virtual public DelayedDeliveryInterface,
        public events::CanTimeout
    {
        friend class tests::SelectiveRepeatTest;
        typedef std::list<CompoundPtr> CompoundContainer;

    public:
        // FUNConfigCreator interface realisation
        SelectiveRepeat(fun::FUN* fuNet, const wns::pyconfig::View& config);
        ~SelectiveRepeat();

        // CanTimeout interface realisation
        virtual void onTimeout();

        // Delayed interface realisation
        virtual bool hasCapacity() const;
        virtual void processOutgoing(const CompoundPtr& sdu);
        // virtual const CompoundPtr hasSomethingToSend() const; // implemented by ARQ
        // virtual CompoundPtr getSomethingToSend(); // implemented by ARQ
        virtual void processIncoming(const CompoundPtr& compound);

        // ARQ interface realization
        virtual const wns::ldk::CompoundPtr hasACK() const;
        virtual const wns::ldk::CompoundPtr hasData() const;
        virtual wns::ldk::CompoundPtr getACK();
        virtual wns::ldk::CompoundPtr getData();

        // Overload of CommandTypeSpecifier Interface
        void calculateSizes(const CommandPool* commandPool, Bit& commandPoolSize, Bit& sduSize) const;

    protected:
        // Internal handlers for I- and ACK-Frames
        void onIFrame(const CompoundPtr& compound);
        void onACKFrame(const CompoundPtr& compound);

        // sort into given Compound List
        void keepSorted(const CompoundPtr& compound, CompoundContainer& conatiner);

        // remove ACKed PDU from list
        void removeACKed(const CompoundPtr& ackCompound, CompoundContainer& container);

        // prepare list of frames to retransmit
        void prepareRetransmission();

        // retransmissionState
        bool retransmissionState() const;

        virtual bool onSuspend() const;

        virtual void doDelayDelivery();
        virtual void doDeliver();

        int windowSize;

        int sequenceNumberSize;

        int commandSize;

        ARQCommand::SequenceNumber NS;

        ARQCommand::SequenceNumber NR;

        ARQCommand::SequenceNumber LA;

        CompoundPtr activeCompound;

        CompoundContainer sentPDUs;

        CompoundContainer toRetransmit;

        CompoundContainer ackPDUs;

        CompoundContainer receivedPDUs;

        CompoundContainer receivedACKs;

        bool sendNow;

        double resendTimeout;

        double retransmissionInterval;

        wns::probe::bus::ContextCollectorPtr transmissionAttemptsProbeBus;
        wns::probe::bus::ContextCollectorPtr ackDelayProbeBus;
        wns::probe::bus::ContextCollectorPtr roundTripTimeProbeBus;

        bool delayingDelivery;

        logger::Logger logger;

    };

}}}

#endif // NOT defined WNS_LDK_ARQ_SELECTIVEREPEAT_HPP

---