LibreOffice Module vcl (master)  1
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
Idle Class Reference

An idle is a timer to be scheduled immediately. More...

#include <idle.hxx>

Inheritance diagram for Idle:
Collaboration diagram for Idle:

Public Member Functions

 Idle (const char *pDebugName)
virtual void Start (bool bStartTimer=true) override
 Schedules the task for execution. More...
- Public Member Functions inherited from Timer
 Timer (const char *pDebugName)
 Timer (const Timer &rTimer)
virtual ~Timer () override
Timeroperator= (const Timer &rTimer)
virtual void Invoke () override
 Calls the maInvokeHandler with the parameter this. More...
void Invoke (Timer *arg)
 Calls the maInvokeHandler with the parameter. More...
void SetInvokeHandler (const Link< Timer *, void > &rLink)
void ClearInvokeHandler ()
void SetTimeout (sal_uInt64 nTimeoutMs)
sal_uInt64 GetTimeout () const
- Public Member Functions inherited from Task
 Task (const char *pDebugName)
 Task (const Task &rTask)
Taskoperator= (const Task &rTask)
void SetPriority (TaskPriority ePriority)
TaskPriority GetPriority () const
const char * GetDebugName () const
void Stop ()
bool IsActive () const
void SetStatic ()
 This function must be called for static tasks, so the Task destructor ignores the scheduler mutex, as it may not be available anymore. More...
bool IsStatic () const

Protected Member Functions

virtual sal_uInt64 UpdateMinPeriod (sal_uInt64 nTimeNow) const override
 How long (in MS) until the Task is ready to be dispatched? More...
 Idle (bool bAuto, const char *pDebugName)
- Protected Member Functions inherited from Timer
virtual void SetDeletionFlags () override
 Timer (bool bAuto, const char *pDebugName)
- Protected Member Functions inherited from Task
const ImplSchedulerDataGetSchedulerData () const

Private Member Functions

void SetTimeout (sal_uInt64 nTimeoutMs)=delete
sal_uInt64 GetTimeout () const =delete

Additional Inherited Members

- Static Protected Member Functions inherited from Task
static void StartTimer (sal_uInt64 nMS)

Detailed Description

An idle is a timer to be scheduled immediately.

It's - more or less - just a convenience class.

Note: Despite the name, the timer is not necessarily invoked when idle. Use an idle priority such as TaskPriority::DEFAULT_IDLE to actually invoke the timer only when idle.

Definition at line 34 of file idle.hxx.

Constructor & Destructor Documentation

Idle::Idle ( bool  bAuto,
const char *  pDebugName 

Definition at line 23 of file idle.cxx.

References DEFAULT_IDLE, and Task::SetPriority().

Idle::Idle ( const char *  pDebugName)

Definition at line 29 of file idle.cxx.

References false.

Member Function Documentation

sal_uInt64 Idle::GetTimeout ( ) const
void Idle::SetTimeout ( sal_uInt64  nTimeoutMs)
void Idle::Start ( bool  bStartTimer = true)
sal_uInt64 Idle::UpdateMinPeriod ( sal_uInt64  nTimeNow) const

How long (in MS) until the Task is ready to be dispatched?

Simply return Scheduler::ImmediateTimeoutMs if you're ready, like an Idle. If you have to return Scheduler::InfiniteTimeoutMs, you probably need another mechanism to wake up the Scheduler or rely on other Tasks to be scheduled, or simply use a polling Timer.

nTimeNowthe current time
the sleep time of the Task to become ready

Reimplemented from Timer.

Definition at line 56 of file idle.cxx.

References Scheduler::ImmediateTimeoutMs.

The documentation for this class was generated from the following files: