User Manual, Developers Guide and API Documentation

CumulativeACK.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 CUMULATIVEACK_HPP
#define CUMULATIVEACK_HPP

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

#include <WNS/ldk/fun/FUN.hpp>

#include <WNS/events/CanTimeout.hpp>

#include <WNS/pyconfig/View.hpp>
#include <WNS/SmartPtr.hpp>
#include <WNS/logger/Logger.hpp>

#include <vector>

namespace wns { namespace ldk { namespace arq {

    class CumulativeACKCommand :
        public ARQCommand
    {
    public:
        CumulativeACKCommand()
        {
            peer.type = I;
            peer.NS = 0;
            peer.NR = 0;
        }
        typedef enum {I, RR, SREJ} FrameType;

        bool isACK() const
        {
            return (peer.type == RR) || (peer.type == SREJ);
        }

        struct {} local;
        struct {
            FrameType type;
            unsigned long int NS;
            unsigned long int NR; 
        } peer;
        struct {} magic;

    };


    class CumulativeACK :
        public ARQ,
        public wns::ldk::fu::Plain<CumulativeACK, CumulativeACKCommand>,
        public Delayed<CumulativeACK>,
        virtual public SuspendableInterface,
        public SuspendSupport,
        virtual public DelayedDeliveryInterface,
        public events::CanTimeout
    {
    private:
        class CAElement:
            public events::CanTimeout
        {
        public:
            CAElement();
            CAElement(CumulativeACK* _parent, unsigned int Time=1 ):
                parent(_parent),
                resendTimeout(Time),
                compound(CompoundPtr()),
                sendNow(false),
                logger("WNS", "CumulativeACK") {};

            ~CAElement()
                {
                    //std::cout<<" Jawoi CAEl destructor has been called ! "<<std::endl;
                    parent = NULL;
                }

            void onTimeout(){
                assure(compound, "no PDU during onTimeout.");
                parent->statusCollector->onFailedTransmission(this->compound);
                sendNow = true;
                MESSAGE_BEGIN(NORMAL, logger, m, parent->getFUN()->getName());
                m << " Timeout of CAElement NS -> " << parent->getCommand(compound->getCommandPool())->peer.NS;
                MESSAGE_END();
                parent->tryToSend();
            }

            wns::ldk::CompoundPtr getCompound(){return compound;};

            CumulativeACK* parent;
            unsigned int resendTimeout;
            wns::ldk::CompoundPtr compound;
            //true if PDU is supposed to be sent. Not being used in case of receiving
            bool sendNow;
            logger::Logger logger;

        };
        typedef std::vector<CAElement> CAElements;
    public:
        CumulativeACK(fun::FUN* fuNet, const wns::pyconfig::View& config);

        ~CumulativeACK();

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

        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;

        virtual bool onSuspend() const;

    protected:
        virtual void doDelayDelivery();
        virtual void doDeliver();

        wns::ldk::CompoundPtr ackCompound;
        unsigned long int wS;
        unsigned long int NS;
        unsigned long int NSack;
        unsigned long int NR;
        int sequenceNumberSize;
        CAElements receivingCompounds;
        CAElements sendingCompounds;
        double resendTimeout;

        bool delayingDelivery;
        int delayedDeliveryNR;

        logger::Logger logger;
    };
}}}
#endif

---