activemq::threads::Task Class Reference

Represents a unit of work that requires one or more iterations to complete. More...

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

Inheritance diagram for activemq::threads::Task:

Public Member Functions
virtual	~Task ()
virtual bool	iterate ()=0
	Perform one iteration of work, returns true if the task needs to run again to complete or false to indicate that the task is now complete.

---

Detailed Description

Represents a unit of work that requires one or more iterations to complete.

Since:

3.0

---

Constructor & Destructor Documentation

virtual activemq::threads::Task::~Task

(

)

[inline, virtual]

---

Member Function Documentation

virtual bool activemq::threads::Task::iterate

(

)

[pure virtual]

Perform one iteration of work, returns true if the task needs to run again to complete or false to indicate that the task is now complete.

Returns:

true if the task should be run again or false if the task has completed and the runner should wait for a wakeup call.

Implemented in activemq::core::ActiveMQSessionExecutor, activemq::threads::CompositeTaskRunner, activemq::transport::failover::BackupTransportPool, activemq::transport::failover::CloseTransportsTask, and activemq::transport::failover::FailoverTransport.

---

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

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