LazyCaller.h

Go to the documentation of this file.

 
#ifndef CNOID_BASE_LAZY_CALLER_H
#define CNOID_BASE_LAZY_CALLER_H
 
#include <functional>
#include "exportdecl.h"
 
namespace cnoid {
    
class LazyCallerImpl;
 
 
class CNOID_EXPORT LazyCaller
{
    friend class LazyCallerImpl;
        
    bool isPending_;
    bool isNextPending;
    LazyCallerImpl* impl;
        
public:
    enum Priority {
        HighPriority = 0,
        NormalPriority,
        LowPriority,
        MinimumPriority,
 
        // deprecated
        PRIORITY_HIGH = HighPriority,
        PRIORITY_NORMAL = NormalPriority,
        PRIORITY_LOW = LowPriority
    };
        
    LazyCaller();
    LazyCaller(const std::function<void(void)>& function, int priority = HighPriority);
    LazyCaller(const LazyCaller& org);
    virtual ~LazyCaller();
 
    void setFunction(const std::function<void(void)>& function);
    void setPriority(int priority);
 
    void setConservative(bool on);
 
    bool isPending() const { return isPending_; }
 
    void flush();
 
    typedef void result_type;
 
    void operator()() {
        if(!isPending_){
            isPending_ = true;
            postCallEvent();
        }
    }
 
    void cancel();
 
private:
    void postCallEvent();
};
 
 
class QueuedCallerImpl;
 
class CNOID_EXPORT QueuedCaller
{
    QueuedCallerImpl* impl;
 
    QueuedCaller(const QueuedCaller& org);
    
  public:
    QueuedCaller();
    virtual ~QueuedCaller();
    
    void callLater(const std::function<void()>& function, int priority = LazyCaller::NormalPriority);
 
    void cancel();
};
 
    
enum { IDLE_PRIORITY_HIGH = LazyCaller::PRIORITY_HIGH,
       IDLE_PRIORITY_NORMAL = LazyCaller::PRIORITY_NORMAL,
       IDLE_PRIORITY_LOW = LazyCaller::PRIORITY_LOW };
 
CNOID_EXPORT void callLater(const std::function<void()>& function, int priority = LazyCaller::NormalPriority);
CNOID_EXPORT void callFromMainThread(const std::function<void()>& function, int priority = LazyCaller::NormalPriority);
CNOID_EXPORT bool callSynchronously(const std::function<void()>& function, int priority = LazyCaller::NormalPriority);
 
CNOID_EXPORT bool isRunningInMainThread();
 
}
        
#endif