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	start ()=0
	Starts the task runner.
virtual bool	isStarted () const =0
virtual void	shutdown (long long 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

~TaskRunner()

virtual activemq::threads::TaskRunner::~TaskRunner ( )

virtual

Member Function Documentation

isStarted()

virtual bool activemq::threads::TaskRunner::isStarted ( ) const

pure virtual

Returns

true if the start method has been called.

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

shutdown() [1/2]

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, activemq::threads::DedicatedTaskRunner, and activemq::transport::failover::CompositeTaskRunner.

shutdown() [2/2]

virtual void activemq::threads::TaskRunner::shutdown ( long long 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, activemq::threads::DedicatedTaskRunner, and activemq::transport::failover::CompositeTaskRunner.

start()

virtual void activemq::threads::TaskRunner::start ( )

pure virtual

Starts the task runner.

Prior to call this method tasks can be added to a Runner, but no executions will occur. The start method will create the background Thread(s) which do the work for this task runner.

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

wakeup()

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, activemq::threads::DedicatedTaskRunner, and activemq::transport::failover::CompositeTaskRunner.

---

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

• src/main/activemq/threads/TaskRunner.h