User Manual, Developers Guide and API Documentation

GoBackN.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_GOBACKN_HPP
#define WNS_LDK_ARQ_GOBACKN_HPP

#include <WNS/pyconfig/View.hpp>

#include <WNS/ldk/arq/ARQ.hpp>
#include <WNS/ldk/CommandTypeSpecifier.hpp>
#include <WNS/ldk/HasReceptor.hpp>
#include <WNS/ldk/HasConnector.hpp>
#include <WNS/ldk/HasDeliverer.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/Cloneable.hpp>
#include <WNS/events/CanTimeout.hpp>
#include <WNS/logger/Logger.hpp>
#include <WNS/probe/bus/ContextCollector.hpp>

#include <list>
#include <cmath>

namespace wns { namespace ldk { namespace arq {

    namespace tests {
        class GoBackNTest;
    }

    class GoBackNCommand :
        public ARQCommand
    {
    public:
        typedef enum {I, ACK, NAK} FrameType;

        GoBackNCommand()
        {
            peer.type = I;
            peer.NS = 0;
        }

        void
        setNS(const SequenceNumber& SN)
        {
            peer.NS = SN;
        }

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

        FrameType
        getFrameType() const
        {
            return peer.type;
        }

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

        struct {} local;
        struct {
            FrameType type;
            int NS;
        } peer;
        struct {
        } magic;
    };


    class GoBackN :
        public ARQ,
        public wns::ldk::fu::Plain<GoBackN, GoBackNCommand>,
        public Delayed<GoBackN>,
        virtual public SuspendableInterface,
        public SuspendSupport,
        virtual public DelayedDeliveryInterface,
        public events::CanTimeout
    {
        friend class ::wns::ldk::arq::tests::GoBackNTest;
        typedef std::list<CompoundPtr> CompoundContainer;

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

        virtual
        ~GoBackN();

        // CanTimeout interface realisation
        virtual void
        onTimeout();

        // Delayed interface realisation
        virtual bool
        hasCapacity() const;

        virtual void
        processOutgoing(const CompoundPtr& sdu);

        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);

        void
        onNAKFrame(const CompoundPtr& compound);

        // remove ACKed PDU from list
        void
        removeACKed(const ARQCommand::SequenceNumber ackedNS, CompoundContainer& container);

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

        // retransmissionState
        bool
        retransmissionState() const;

        void
        show_seqnr_list(const char* name, CompoundContainer& compoundList) const;

        virtual bool
        onSuspend() const;

        virtual void
        doDelayDelivery();

        virtual void
        doDeliver();

        int windowSize;

        int sequenceNumberSize;

        int bitsPerIFrame; // = (int) ceil(log(sequenceNumberSize) / log(2));

        int bitsPerACKFrame; // = (int) ceil(log(sequenceNumberSize) / log(2));

        ARQCommand::SequenceNumber NS;

        ARQCommand::SequenceNumber NR;

        ARQCommand::SequenceNumber LA; // LA=1 means seqnr=0 was acked before

        CompoundPtr activeCompound;

        CompoundContainer sentPDUs;

        CompoundContainer toRetransmit;

        CompoundContainer ackPDUs;

        CompoundContainer receivedPDUs;

        bool sendNow;

        double resendTimeout;

        wns::probe::bus::ContextCollectorPtr transmissionAttempts;

        bool delayingDelivery;

        ARQCommand::SequenceNumber delayedDeliveryNR;

        logger::Logger logger;

    };

}}}

#endif // NOT defined WNS_LDK_ARQ_GOBACKN_HPP

---