User Manual, Developers Guide and API Documentation

CanTimeout.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_CANTIMEOUT_HPP
#define WNS_EVENTS_CANTIMEOUT_HPP

#include <WNS/events/scheduler/IEvent.hpp>


namespace wns { namespace events {

    namespace scheduler {
        class Interface;
    }

    class CanTimeout
    {
        class TimeoutEvent
        {
        public:
            explicit
            TimeoutEvent(CanTimeout* _target);

            virtual
            ~TimeoutEvent();

            virtual void
            operator()();

            virtual void
            print(std::ostream& aStreamRef = std::cout) const;

        private:
            CanTimeout* target;
        };

    public:
        CanTimeout();

        virtual
        ~CanTimeout();

        //{@
        void
        setTimeout(double delay);

        void
        setNewTimeout(double delay);

        bool
        hasTimeoutSet() const;

        void
        cancelTimeout();

        virtual void
        onTimeout() = 0;

    private:
        scheduler::IEventPtr event;

        wns::events::scheduler::Interface* scheduler;
    }; // CanTimeout

} // events
} // wns

#endif // NOT defined WNS_EVENTS_CANTIMEOUT_HPP

/*
  Local Variables:
  mode: c++
  fill-column: 80
  c-basic-offset: 8
  c-comment-only-line-offset: 0
  c-tab-always-indent: t
  indent-tabs-mode: t
  tab-width: 8
  End:
*/

---