Task Class Reference

#include <task.hxx>

Inheritance diagram for Task:

Collaboration diagram for Task:

Public Member Functions
	Task (const sal_Char *pDebugName)
	Task (const Task &rTask)
virtual	~Task () COVERITY_NOEXCEPT_FALSE
Task &	operator= (const Task &rTask)
void	SetPriority (TaskPriority ePriority)
TaskPriority	GetPriority () const
void	SetDebugName (const sal_Char *pDebugName)
const char *	GetDebugName () const
virtual void	Invoke ()=0
virtual void	Start ()
void	Stop ()
bool	IsActive () const
void	SetStatic ()
	This function must be called for static tasks, so the Task destructor ignores the SchedulerMutex, as it may not be available anymore. More...
bool	IsStatic () const

Protected Member Functions
const ImplSchedulerData *	GetSchedulerData () const
virtual void	SetDeletionFlags ()
virtual sal_uInt64	UpdateMinPeriod (sal_uInt64 nTimeNow) const =0
	How long (in MS) until the Task is ready to be dispatched? More...

Static Protected Member Functions
static void	StartTimer (sal_uInt64 nMS)

Private Attributes
ImplSchedulerData *	mpSchedulerData
	Pointer to the element in scheduler list. More...
const sal_Char *	mpDebugName
	Useful for debugging. More...
TaskPriority	mePriority
	Task priority. More...
bool	mbActive
	Currently in the scheduler. More...
bool	mbStatic
	Is a static object. More...

Friends
class	Scheduler
struct	ImplSchedulerData

Detailed Description

Definition at line 41 of file task.hxx.

Constructor & Destructor Documentation

Task::Task

(

const sal_Char *

pDebugName

)

Definition at line 627 of file scheduler.cxx.

References DEFAULT, and mbActive.

Task::Task

(

const Task &

rTask

)

Definition at line 636 of file scheduler.cxx.

References IsActive(), mbActive, and Start().

Task::~Task ( )

virtual

Definition at line 647 of file scheduler.cxx.

References utl::ConfigManager::IsFuzzing(), IsStatic(), mpSchedulerData, and ImplSchedulerData::mpTask.

Member Function Documentation

const char* Task::GetDebugName ( ) const

inline

Definition at line 82 of file task.hxx.

Referenced by Scheduler::ImplDeInitScheduler(), Scheduler::ProcessEventsToIdle(), and Scheduler::ProcessTaskScheduling().

TaskPriority Task::GetPriority ( ) const

inline

Definition at line 79 of file task.hxx.

References ImplSchedulerData::mePriority.

Referenced by AppendSchedulerData(), and Idle::Start().

const ImplSchedulerData* Task::GetSchedulerData ( ) const

inlineprotected

Definition at line 55 of file task.hxx.

Referenced by Timer::UpdateMinPeriod().

virtual void Task::Invoke ( )

pure virtual

Implemented in Timer, and DebugEventInjector.

Referenced by Scheduler::ProcessTaskScheduling().

bool Task::IsActive ( ) const

inline

Definition at line 90 of file task.hxx.

Referenced by SelectionEngine::Command(), IdleFormatter::DoIdleFormat(), IdleFormatter::ForceTimeout(), SystemWindow::hasPendingLayout(), Throbber::isRunning(), operator=(), Scheduler::ProcessEventsToIdle(), Scheduler::ProcessTaskScheduling(), vcl::RoadmapWizard::queue_resize(), DockingWindow::queue_resize(), SelectionEngine::SelMouseMove(), Timer::SetTimeout(), SelectionEngine::SetUpdateInterval(), ProgressBar::SetValue(), SpinButton::StateChanged(), and Task().

bool Task::IsStatic ( ) const

inline

Definition at line 99 of file task.hxx.

Referenced by ~Task().

Task & Task::operator=

(

const Task &

rTask

)

Definition at line 610 of file scheduler.cxx.

References IsActive(), mbActive, mePriority, Start(), and Stop().

Referenced by Timer::operator=().

void Task::SetDebugName ( const sal_Char *  pDebugName )

inline

Definition at line 81 of file task.hxx.

Referenced by UIObjectUnoObj::executeAction(), HelpTextWindow::HelpTextWindow(), ImplFrameData::ImplFrameData(), DockingWindow::ImplInitDockingWindowData(), WorkWindow::ImplInitWorkWindowData(), SvInplaceEdit2::LoseFocus(), vcl::graphic::Manager::Manager(), MenuFloatingWindow::MenuFloatingWindow(), vcl::QuickSelectionEngine_Data::QuickSelectionEngine_Data(), SelectionEngine::SelectionEngine(), SystemWindow::SetIdleDebugName(), DockingWindow::SetIdleDebugName(), vcl::Window::StartTracking(), SvxIconChoiceCtrl_Impl::SvxIconChoiceCtrl_Impl(), and SystemWindow::SystemWindow().

void Task::SetDeletionFlags ( )

protectedvirtual

Reimplemented in Timer.

Definition at line 546 of file scheduler.cxx.

References mbActive.

Referenced by Scheduler::ProcessTaskScheduling(), and Timer::SetDeletionFlags().

void Task::SetPriority

(

TaskPriority

ePriority

)

Definition at line 600 of file scheduler.cxx.

References mbActive, mePriority, mpSchedulerData, and SAL_WARN_IF.

Referenced by Application::Execute(), UIObjectUnoObj::executeAction(), Idle::Idle(), IdleFormatter::IdleFormatter(), ImplFrameData::ImplFrameData(), vcl::RoadmapWizard::ImplInitData(), DockingWindow::ImplInitDockingWindowData(), SvInplaceEdit2::LoseFocus(), ProgressBar::SetValue(), SvImpLBox::SvImpLBox(), SvxIconChoiceCtrl_Impl::SvxIconChoiceCtrl_Impl(), SystemWindow::SystemWindow(), and Timer::Timer().

void Task::SetStatic ( )

inline

This function must be called for static tasks, so the Task destructor ignores the SchedulerMutex, as it may not be available anymore.

The cleanup is still correct, as it has already happened in DeInitScheduler call well before the static destructor calls.

Definition at line 98 of file task.hxx.

Referenced by Scheduler::ImplDeInitScheduler().

void Task::Start ( )

virtual

Reimplemented in Timer, and Idle.

Definition at line 551 of file scheduler.cxx.

References AppendSchedulerData(), tools::Time::GetSystemTicks(), ImplGetSVData(), ImplSchedulerData, ImplSVData::maSchedCtx, mbActive, ImplSchedulerContext::mbActive, ImplSchedulerData::mbInScheduler, ImplSchedulerData::mePriority, mePriority, ImplSchedulerData::mnUpdateTime, mpSchedulerData, ImplSchedulerData::mpTask, and SAL_INFO.

Referenced by operator=(), Idle::Start(), Timer::Start(), and Task().

void Task::StartTimer ( sal_uInt64  nMS )

staticprotected

Definition at line 541 of file scheduler.cxx.

References tools::Time::GetSystemTicks(), and Scheduler::ImplStartTimer().

Referenced by Timer::SetTimeout(), Idle::Start(), and Timer::Start().

void Task::Stop

(

)

Definition at line 593 of file scheduler.cxx.

References tools::Time::GetSystemTicks(), mbActive, mpSchedulerData, and SAL_INFO_IF.

Referenced by SvInplaceEdit2::CallCallBackHdl_Impl(), MenuFloatingWindow::ChangeHighlightItem(), Animation::Clear(), SelectionEngine::Command(), SvImpLBox::Command(), Throbber::dispose(), HelpTextWindow::dispose(), vcl::RoadmapWizard::dispose(), SystemWindow::dispose(), MenuFloatingWindow::doShutdown(), IdleFormatter::ForceTimeout(), SvxIconChoiceCtrl_Impl::ImpArrange(), MenuFloatingWindow::ImplScroll(), SvImpLBox::KeyInput(), SvImpLBox::LoseFocus(), SvImpLBox::MouseButtonDown(), SpinField::MouseButtonUp(), SpinButton::MouseButtonUp(), SpinField::MouseMove(), SpinButton::MouseMove(), MenuFloatingWindow::MouseMove(), operator=(), SelectionEngine::Reset(), SelectionEngine::SelMouseButtonUp(), SystemWindow::setOptimalLayoutSize(), DockingWindow::setOptimalLayoutSize(), SelectionEngine::SetUpdateInterval(), Animation::Start(), SpinButton::StateChanged(), Animation::Stop(), Throbber::stop(), MenuFloatingWindow::StopExecute(), vcl::QuickSelectionEngine_Data::~QuickSelectionEngine_Data(), SelectionEngine::~SelectionEngine(), and SvImpLBox::~SvImpLBox().

virtual sal_uInt64 Task::UpdateMinPeriod ( sal_uInt64  nTimeNow ) const

protectedpure virtual

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.

Parameters

nTimeNow

the current time

Returns

the sleep time of the Task to become ready

Implemented in Idle, and Timer.

Referenced by Scheduler::ProcessTaskScheduling().

Friends And Related Function Documentation

friend struct ImplSchedulerData

friend

Definition at line 44 of file task.hxx.

Referenced by Start().

friend class Scheduler

friend

Definition at line 43 of file task.hxx.

Member Data Documentation

bool Task::mbActive

private

Currently in the scheduler.

Definition at line 49 of file task.hxx.

Referenced by Scheduler::ImplDeInitScheduler(), operator=(), SetDeletionFlags(), SetPriority(), Start(), and Stop().

bool Task::mbStatic

private

Is a static object.

Definition at line 50 of file task.hxx.

TaskPriority Task::mePriority

private

Task priority.

Definition at line 48 of file task.hxx.

Referenced by operator=(), SetPriority(), and Start().

const sal_Char* Task::mpDebugName

private

Useful for debugging.

Definition at line 47 of file task.hxx.

ImplSchedulerData* Task::mpSchedulerData

private

Pointer to the element in scheduler list.

Definition at line 46 of file task.hxx.

Referenced by Scheduler::ImplDeInitScheduler(), Scheduler::ProcessTaskScheduling(), SetPriority(), Start(), Stop(), and ~Task().

---

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

• task.hxx
• scheduler.cxx