Timer::TimerTask Class Reference

Inheritance diagram for Timer::TimerTask:

Collaboration diagram for Timer::TimerTask:

Public Member Functions
	TimerTask (TimerPtr timer, boost::system::error_code ec)
virtual	~TimerTask ()
virtual bool	Run ()
	Code to execute. Returns true if task is completed. Return false to reschedule the task. More...
void	OnTaskCancel ()
	Called on task exit, if it is marked for cancellation. If the user wants to do any cleanup on task cancellation, then he/she can overload this function. More...
virtual std::string	Description () const
Public Member Functions inherited from Task
	Task (int task_id, int task_instance)
	Task (int task_id)
virtual	~Task ()
State	GetState () const
int	GetTaskId () const
int	GetTaskInstance () const
uint64_t	GetSeqno () const
bool	task_cancelled () const
uint64_t	enqueue_time () const
uint64_t	schedule_time () const
uint32_t	execute_delay () const
uint32_t	schedule_delay () const

Private Member Functions
	DISALLOW_COPY_AND_ASSIGN (TimerTask)

Private Attributes
TimerPtr	timer_
boost::system::error_code	ec_

Additional Inherited Members
Public Types inherited from Task
enum	State { INIT, WAIT, RUN }
	Task states. More...
enum	TbbState { TBB_INIT, TBB_ENQUEUED, TBB_EXEC, TBB_DONE }
Static Public Member Functions inherited from Task
static Task *	Running ()
	Returns a pointer to the current task the code is executing under. More...
Static Public Attributes inherited from Task
static const int	kTaskInstanceAny = -1

Detailed Description

Definition at line 8 of file timer.cc.

Constructor & Destructor Documentation

Timer::TimerTask::TimerTask ( TimerPtr  timer, boost::system::error_code  ec  )

inline

Definition at line 10 of file timer.cc.

virtual Timer::TimerTask::~TimerTask ( )

inlinevirtual

Definition at line 14 of file timer.cc.

Member Function Documentation

virtual std::string Timer::TimerTask::Description ( ) const

inlinevirtual

Implements Task.

Definition at line 73 of file timer.cc.

Timer::TimerTask::DISALLOW_COPY_AND_ASSIGN ( TimerTask  )

private

void Timer::TimerTask::OnTaskCancel ( )

inlinevirtual

Called on task exit, if it is marked for cancellation. If the user wants to do any cleanup on task cancellation, then he/she can overload this function.

Reimplemented from Task.

Definition at line 59 of file timer.cc.

virtual bool Timer::TimerTask::Run ( )

inlinevirtual

Code to execute. Returns true if task is completed. Return false to reschedule the task.

Implements Task.

Definition at line 19 of file timer.cc.

Here is the call graph for this function:

Member Data Documentation

boost::system::error_code Timer::TimerTask::ec_

private

Definition at line 79 of file timer.cc.

TimerPtr Timer::TimerTask::timer_

private

Definition at line 78 of file timer.cc.

---

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

• timer.cc