User Manual, Developers Guide and API Documentation

CommandQueue.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. 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 WNS_EVENTS_SCHEDULER_COMMANDQUEUE_HPP
#define WNS_EVENTS_SCHEDULER_COMMANDQUEUE_HPP

#include <WNS/events/scheduler/ICommand.hpp>
#include <WNS/events/scheduler/Callable.hpp>
#include <WNS/container/FastListEnabler.hpp>
#include <WNS/container/FastList.hpp>
#include <WNS/Assure.hpp>

#include <pthread.h>

namespace wns { namespace events { namespace scheduler {
    class CommandQueue
    {
    public:
        CommandQueue();

        virtual
        ~CommandQueue();

        void
        reset();

        ICommandPtr
        queueCommand(const Callable& callee);

        void
        dequeueCommand(const ICommandPtr& command);

        void
        runCommands();

    private:

        class Command :
            public virtual ICommand,
            public wns::container::SingleFastListEnabler< wns::SmartPtr<Command> >
        {
        public:
            Command(const wns::events::scheduler::Callable& callable) :
                callable_(callable),
                state_(NotSubmitted)
            {
            }

            void
            operator()()
            {
                callable_();
            }

            enum State {
                NotSubmitted,
                Queued,
                Running,
                Finished,
                Canceled
            };

            virtual bool
            isNotSubmitted() const
            {
                return NotSubmitted == state_;
            }

            virtual bool
            isQueued() const
            {
                return Queued == state_;
            }

            virtual bool
            isRunning() const
            {
                return Running == state_;
            }

            virtual bool
            isFinished() const
            {
                return Finished == state_;
            }

            virtual bool
            isCanceled() const
            {
                return Canceled == state_;
            }

            wns::events::scheduler::Callable callable_;

            State state_;
        };

        typedef wns::SmartPtr<Command> CommandPtr;

        typedef wns::container::FastList<CommandPtr> CommandContainer;

        CommandContainer queue_;

        pthread_mutex_t mutex_;

    }; // CommandQueue
} // scheduler
} // events
} // wns

#endif // NOT defined WNS_EVENTS_SCHEDULER_COMMANDQUEUE_HPP

---