activemq-cpp-3.6.0
activemq::threads::DedicatedTaskRunner Class Reference

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

Inheritance diagram for activemq::threads::DedicatedTaskRunner:

Public Member Functions

 DedicatedTaskRunner (Task *task)
virtual ~DedicatedTaskRunner ()
virtual void start ()
 Starts the task runner.
virtual bool isStarted () const
 true if the start method has been called.
virtual void shutdown (long long timeout)
 Shutdown after a timeout, does not guarantee that the task's iterate method has completed and the thread halted.
virtual void shutdown ()
 Shutdown once the task has finished and the TaskRunner's thread has exited.
virtual void wakeup ()
 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.
- Public Member Functions inherited from activemq::threads::TaskRunner
virtual ~TaskRunner ()
- Public Member Functions inherited from decaf::lang::Runnable
virtual ~Runnable ()

Protected Member Functions

virtual void run ()
 Run method - called by the Thread class in the context of the thread.

Constructor & Destructor Documentation

activemq::threads::DedicatedTaskRunner::DedicatedTaskRunner ( Task task)
virtual activemq::threads::DedicatedTaskRunner::~DedicatedTaskRunner ( )
virtual

Member Function Documentation

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

true if the start method has been called.

Implements activemq::threads::TaskRunner.

virtual void activemq::threads::DedicatedTaskRunner::run ( )
protectedvirtual

Run method - called by the Thread class in the context of the thread.

Implements decaf::lang::Runnable.

virtual void activemq::threads::DedicatedTaskRunner::shutdown ( long long  timeout)
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.

Implements activemq::threads::TaskRunner.

virtual void activemq::threads::DedicatedTaskRunner::shutdown ( )
virtual

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

Implements activemq::threads::TaskRunner.

virtual void activemq::threads::DedicatedTaskRunner::start ( )
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.

Implements activemq::threads::TaskRunner.

virtual void activemq::threads::DedicatedTaskRunner::wakeup ( )
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.

Implements activemq::threads::TaskRunner.


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