src/main/decaf/util/TimerTask.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_TIMERTASK_H_
#define _DECAF_UTIL_TIMERTASK_H_

#include <decaf/util/Config.h>
#include <decaf/lang/Runnable.h>
#include <decaf/util/concurrent/Mutex.h>

namespace decaf {
namespace internal{
    namespace util{
        class TimerTaskHeap;
    }
}
namespace util {

    class Timer;
    class TimerImpl;

    class DECAF_API TimerTask : public lang::Runnable {
    private:

        // Timer will use this lock to sync with mutating methods in this class.
        mutable decaf::util::concurrent::Mutex lock;

        bool fixedRate;
        bool cancelled;
        long long scheduledTime;
        long long when;
        long long period;

        friend class Timer;
        friend class TimerImpl;
        friend class decaf::internal::util::TimerTaskHeap;

    public:

        TimerTask();
        virtual ~TimerTask() {}

        bool cancel();

        long long scheduledExecutionTime() const;

    protected:

        bool isScheduled() const;
        void setScheduledTime( long long time );
        long long getWhen() const;

    };

}}

#endif /* _DECAF_UTIL_TIMERTASK_H_ */