User Manual, Developers Guide and API Documentation

BypassQueue.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
 * 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/>.
 *
 ******************************************************************************/
#pragma once

#include <boost/function.hpp>
#include <boost/noncopyable.hpp>
#include <WNS/scheduler/queue/QueueInterface.hpp>

namespace wns { namespace ldk {
    class HasReceptorInterface;
    }}


namespace wimac { namespace scheduler {

    class BypassQueue:
        public wns::scheduler::queue::QueueInterface,
        boost::noncopyable
    {
    public:
        BypassQueue(wns::ldk::HasReceptorInterface* parent, const wns::pyconfig::View& config);


        bool
        queueHasPDUs(wns::scheduler::ConnectionID) const;

        virtual bool
        isEmpty() const;

        wns::scheduler::ConnectionSet
        filterQueuedCids(wns::scheduler::ConnectionSet connections);


        wns::ldk::CompoundPtr
        getHeadOfLinePDU(wns::scheduler::ConnectionID cid);

        int
        getHeadOfLinePDUbits(wns::scheduler::ConnectionID cid);

        bool
        hasQueue(wns::scheduler::ConnectionID cid);

        ProbeOutput
        resetAllQueues();

        ProbeOutput
        resetQueues(wns::scheduler::UserID);

        virtual void
        frameStarts();


        ProbeOutput
        resetQueue(wns::scheduler::ConnectionID);

        bool
        supportsDynamicSegmentation() const;

        wns::ldk::CompoundPtr
        getHeadOfLinePDUSegment(wns::scheduler::ConnectionID cid, int bits);

        wns::scheduler::UserSet
        getQueuedUsers() const;

        wns::scheduler::ConnectionSet
        getActiveConnections() const;

        wns::scheduler::ConnectionSet
        getActiveConnectionsForPriority(unsigned int priority) const;

        //unsigned long int
        //numCompoundsForUser(wns::scheduler::UserID user) const;

        unsigned long int
        numCompoundsForCid(wns::scheduler::ConnectionID cid) const;

        //unsigned long int
        //numBitsForUser(wns::scheduler::UserID user) const;

        unsigned long int
        numBitsForCid(wns::scheduler::ConnectionID cid) const;

        wns::scheduler::QueueStatusContainer
        getQueueStatus() const;

        bool
        isAccepting(const wns::ldk::CompoundPtr&) const;

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

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

        void
        setColleagues(wns::scheduler::RegistryProxyInterface* registry);

        void
        setFUN(wns::ldk::fun::FUN* fun);

        std::string
        printAllQueues();

        wns::ldk::Receptor*
        getReceptor() const;


        struct IsAcceptingChecker
        {
            virtual bool operator()(const wns::ldk::CompoundPtr&) = 0;
        };

    private:

        wns::ldk::HasReceptorInterface* hasReceptor_;

        mutable IsAcceptingChecker* isAcceptingChecker_;

        wns::ldk::CompoundPtr current_;

        struct {
            wns::scheduler::RegistryProxyInterface* registry;
        } colleagues_;
    };

}
}

---