User Manual, Developers Guide and API Documentation

QueueInterface.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_QUEUEINTERFACE_HPP
#define WNS_SCHEDULER_QUEUE_QUEUEINTERFACE_HPP

#include <WNS/scheduler/SchedulerTypes.hpp>
#include <WNS/scheduler/RegistryProxyInterface.hpp>
#include <WNS/HasReceptorConfigCreator.hpp>
#include <queue>

namespace wns { namespace scheduler { namespace queue {

            class QueueInterface {
            public:
                struct ProbeOutput{
                    ProbeOutput()
                        : bits(0),
                          compounds(0)
                    {}
                    Bits bits;
                    int compounds;
                };

                virtual ~QueueInterface() {};

                virtual bool queueHasPDUs(ConnectionID cid) const = 0;

                virtual ConnectionSet filterQueuedCids(ConnectionSet connections) = 0;

                virtual wns::ldk::CompoundPtr getHeadOfLinePDU(ConnectionID cid) = 0;

                virtual int getHeadOfLinePDUbits(ConnectionID cid) = 0;

                virtual bool isEmpty() const = 0;

                virtual bool hasQueue(ConnectionID cid) = 0;

                virtual ProbeOutput resetAllQueues() = 0;

                virtual ProbeOutput resetQueues(UserID user) = 0;

                virtual void frameStarts() = 0;

                virtual ProbeOutput resetQueue(ConnectionID cid) = 0;

                virtual bool supportsDynamicSegmentation() const = 0;
                virtual wns::ldk::CompoundPtr getHeadOfLinePDUSegment(ConnectionID cid, int bits) = 0;
                virtual int getMinimumSegmentSize() const { return 0;};

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

                virtual UserSet getQueuedUsers() const = 0;

                virtual ConnectionSet getActiveConnections() const = 0;

                virtual unsigned long int numCompoundsForCid(ConnectionID cid) const = 0;

                virtual unsigned long int numBitsForCid(ConnectionID cid) const = 0;

                virtual QueueStatusContainer getQueueStatus() const = 0;

                virtual bool isAccepting(const wns::ldk::CompoundPtr& compound) const = 0;

                virtual void put(const wns::ldk::CompoundPtr& compound) = 0;

                virtual void setColleagues(RegistryProxyInterface* registry) = 0;

                virtual void setFUN(wns::ldk::fun::FUN* fun) = 0;

                virtual std::string printAllQueues() = 0;

            };
            //typedef wns::PyConfigViewCreator<QueueInterface, QueueInterface> QueueCreator;
            typedef wns::HasReceptorConfigCreator<QueueInterface, QueueInterface> QueueCreator;
            typedef wns::StaticFactory<QueueCreator> QueueFactory;



        }}} // namespace wns::scheduler::queue
#endif // WNS_SCHEDULER_QUEUE_QUEUEINTERFACE_HPP

---