activemq-cpp-3.4.0

activemq::threads::TaskRunner Class Reference

#include <src/main/activemq/threads/TaskRunner.h>

Inheritance diagram for activemq::threads::TaskRunner:

Public Member Functions

virtual ~TaskRunner ()
virtual void shutdown (unsigned int timeout)=0
 Shutdown after a timeout, does not guarantee that the task's iterate method has completed and the thread halted.
virtual void shutdown ()=0
 Shutdown once the task has finished and the TaskRunner's thread has exited.
virtual void wakeup ()=0
 Signal the TaskRunner to wakeup and execute another iteration cycle on the task, the Task instance will be run until its iterate method has returned false indicating it is done.

Constructor & Destructor Documentation

virtual activemq::threads::TaskRunner::~TaskRunner ( ) [inline, virtual]

Member Function Documentation

virtual void activemq::threads::TaskRunner::shutdown ( unsigned int  timeout) [pure virtual]

Shutdown after a timeout, does not guarantee that the task's iterate method has completed and the thread halted.

Parameters:
timeout- Time in Milliseconds to wait for the task to stop.

Implemented in activemq::threads::CompositeTaskRunner, and activemq::threads::DedicatedTaskRunner.

virtual void activemq::threads::TaskRunner::shutdown ( ) [pure virtual]

Shutdown once the task has finished and the TaskRunner's thread has exited.

Implemented in activemq::threads::CompositeTaskRunner, and activemq::threads::DedicatedTaskRunner.

virtual void activemq::threads::TaskRunner::wakeup ( ) [pure virtual]

Signal the TaskRunner to wakeup and execute another iteration cycle on the task, the Task instance will be run until its iterate method has returned false indicating it is done.

Implemented in activemq::threads::CompositeTaskRunner, and activemq::threads::DedicatedTaskRunner.


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