Timer.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _DECAF_UTIL_TIMER_H_
#define _DECAF_UTIL_TIMER_H_

#include <memory>

#include <decaf/util/Config.h>
#include <decaf/util/Date.h>
#include <decaf/util/concurrent/TimeUnit.h>
#include <decaf/lang/Pointer.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/lang/exceptions/IllegalStateException.h>
#include <decaf/lang/exceptions/IllegalArgumentException.h>

namespace decaf {
namespace util {

    class TimerTask;
    class TimerImpl;

    class DECAF_API Timer {
    private:

        TimerImpl* internal;

    private:

        Timer(const Timer&);
        Timer operator=(const Timer&);

    public:

        Timer();

        Timer(const std::string& name);

        virtual ~Timer();

        void cancel();

        bool awaitTermination(long long timeout, const decaf::util::concurrent::TimeUnit& unit);

        int purge();

        void schedule(TimerTask* task, long long delay);

        void schedule(const decaf::lang::Pointer<TimerTask>& task, long long delay);

        void schedule(TimerTask* task, const Date& time);

        void schedule(const decaf::lang::Pointer<TimerTask>& task, const Date& time);

        void schedule(TimerTask* task, long long delay, long long period);

        void schedule(const decaf::lang::Pointer<TimerTask>& task, long long delay, long long period);

        void schedule(TimerTask* task, const Date& firstTime, long long period);

        void schedule(const decaf::lang::Pointer<TimerTask>& task, const Date& firstTime, long long period);

        void scheduleAtFixedRate(TimerTask* task, long long delay, long long period);

        void scheduleAtFixedRate(const decaf::lang::Pointer<TimerTask>& task, long long delay, long long period);

        void scheduleAtFixedRate(TimerTask* task, const Date& firstTime, long long period);

        void scheduleAtFixedRate(const decaf::lang::Pointer<TimerTask>& task, const Date& firstTime, long long period);

    private:

        void scheduleTask(const decaf::lang::Pointer<TimerTask>& task, long long delay, long long period, bool fixed);

    };

}}

#endif /* _DECAF_UTIL_TIMER_H_ */