User Manual, Developers Guide and API Documentation

SimpleQueue.hpp

Go to the documentation of this file.

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

#include <WNS/scheduler/SchedulerTypes.hpp>
#include <WNS/scheduler/queue/QueueInterface.hpp>
#include <WNS/StaticFactory.hpp>
#include <WNS/ldk/CommandTypeSpecifier.hpp>

#include <WNS/probe/bus/ContextCollector.hpp>

#include <map>
#include <queue>

namespace wns { namespace ldk {
    class HasReceptorInterface;
    }}

namespace wns { namespace scheduler { namespace queue {

            class SimpleQueue :
            public QueueInterface
            {
            public:
                SimpleQueue(wns::ldk::HasReceptorInterface*, const wns::pyconfig::View& config);
                virtual ~SimpleQueue();

                bool isAccepting(const wns::ldk::CompoundPtr& compound) const;
                void put(const wns::ldk::CompoundPtr& compound);

                UserSet getQueuedUsers() const;
                ConnectionSet getActiveConnections() const;

                unsigned long int numCompoundsForCid(ConnectionID cid) const;
                unsigned long int numBitsForCid(ConnectionID cid) const;

                QueueStatusContainer getQueueStatus() const;

                wns::ldk::CompoundPtr getHeadOfLinePDU(ConnectionID cid);
                int getHeadOfLinePDUbits(ConnectionID cid);

                bool isEmpty() const;
                bool hasQueue(ConnectionID cid);
                bool queueHasPDUs(ConnectionID cid) const;
                ConnectionSet filterQueuedCids(ConnectionSet connections);

                void setColleagues(RegistryProxyInterface* _registry);
                void setFUN(wns::ldk::fun::FUN* fun);

                std::string printAllQueues();

                ProbeOutput resetAllQueues();
                ProbeOutput resetQueues(UserID user);
                ProbeOutput resetQueue(ConnectionID cid);

                void frameStarts() {};

                bool supportsDynamicSegmentation() const { return false; }
                wns::ldk::CompoundPtr getHeadOfLinePDUSegment(ConnectionID cid, int bits) { throw wns::Exception("getHeadOfLinePDUSegment() is unsupported"); return wns::ldk::CompoundPtr(); }
                int getMinimumSegmentSize() const { throw wns::Exception("getHeadOfLinePDUSegment() is unsupported"); return 0; };

                std::queue<wns::ldk::CompoundPtr> 
                getQueueCopy(ConnectionID cid);                

            protected:
                void
                probe();

            private:
                wns::probe::bus::contextprovider::Variable* probeContextProviderForCid;
                wns::probe::bus::contextprovider::Variable* probeContextProviderForPriority;
                wns::probe::bus::ContextCollectorPtr sizeProbeBus;
                // Every CID has its own queue. A user might have multiple CIDs
                // associated with it. Queue length counters exist for every queue/CID.
                struct Queue {
                    Queue()
                        : bits(0)
                    {}
                    Bits bits;
                    std::queue<wns::ldk::CompoundPtr> pduQueue;
                };

                long int maxSize;

                typedef std::map<ConnectionID, Queue> QueueContainer;
                QueueContainer queues;

                struct Colleagues {
                    Colleagues() : registry(NULL) {}
                    RegistryProxyInterface* registry;
                } colleagues;

                wns::logger::Logger logger;
                wns::pyconfig::View config;
                wns::ldk::fun::FUN* myFUN;
            };
        }}} // namespace wns::scheduler::queue
#endif // WNS_SCHEDULER_QUEUE_SIMPLEQUEUE_HPP

---