User Manual, Developers Guide and API Documentation

TransmissionQueue.hpp

Go to the documentation of this file.

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

#include <WIFIMAC/draftn/BlockACKCommand.hpp>
#include <WIFIMAC/management/PERInformationBase.hpp>

#include <WNS/ldk/Compound.hpp>
#include <WNS/service/dll/Address.hpp>
#include <WNS/ldk/buffer/Buffer.hpp>

namespace wifimac {
    namespace draftn {

        class BlockACK;

        class TransmissionQueue
        {

            typedef std::pair<wns::ldk::CompoundPtr, wns::simulator::Time> CompoundPtrWithTime;

        public:
            TransmissionQueue(BlockACK* parent_,
                              size_t maxOnAir_,
                              wns::simulator::Time maxDelay,
                              wns::service::dll::UnicastAddress adr_,
                              BlockACKCommand::SequenceNumber sn_,
                              wifimac::management::PERInformationBase* perMIB_,
                              std::auto_ptr<wns::ldk::buffer::SizeCalculator> *sizeCalculator);
            ~TransmissionQueue();

            void
            processOutgoing(const wns::ldk::CompoundPtr& compound);

            const wns::ldk::CompoundPtr
            hasData() const;

            wns::ldk::CompoundPtr
            getData();

            void
            processIncomingACK(std::set<BlockACKCommand::SequenceNumber> ackSNs);

            const size_t getNumOnAirPDUs() const
                { return onAirQueue.size(); }

            const size_t getNumWaitingPDUs() const
                { return txQueue.size(); }

            const unsigned int
            onAirQueueSize() const;

            const unsigned int
            txQueueSize() const;

            const unsigned int
            storageSize() const;

            const bool
            waitsForACK() const;

            const BlockACKCommand::SequenceNumber
            getNextSN() const
                {
                    return nextSN;
                }

            const wns::service::dll::UnicastAddress
            getReceiver()
                {
                    return adr;
                }

            void setMaxDelay(wns::simulator::Time delay)
                {
                    maxDelay = delay;
                }

            wns::simulator::Time getOldestTimestamp()
                {
                    if (oldestTimestamp > wns::simulator::Time())
                        return oldestTimestamp + maxDelay;
                    else
                        return 0;
                }

            std::list<wns::ldk::CompoundPtr>
            getAirableCompounds();

            const size_t
            maxAirSize()
                {
                    return maxOnAir;
                }

            void setMaxOnAir(size_t maxAir) 
                {
                    maxOnAir = maxAir;
                }

            wns::ldk::CompoundPtr
            getTxFront();

        private:
            bool
            isSortedBySN(const std::deque<CompoundPtrWithTime> q) const;

            wns::ldk::CompoundPtr baREQ;
            wifimac::management::PERInformationBase* perMIB;
            wns::simulator::Time maxDelay;
            wns::simulator::Time oldestTimestamp;
            size_t maxOnAir;
            const BlockACK* parent;
            const wns::service::dll::UnicastAddress adr;
            std::deque<CompoundPtrWithTime> txQueue;
            std::deque<CompoundPtrWithTime> onAirQueue;
            BlockACKCommand::SequenceNumber nextSN;
            bool waitForACK;
            bool baReqRequired;
            std::auto_ptr<wns::ldk::buffer::SizeCalculator> *sizeCalculator;
        };

} // mac
} // wifimac

#endif // WIFIMAC_LOWERMAC_BLOCKACK_TRANSMISSIONQUEUE_HPP

---