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

Represents a single task that can be part of a set of Tasks that are contained in a CompositeTaskRunner. More...

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

Inheritance diagram for activemq::threads::CompositeTask:

Public Member Functions

virtual ~CompositeTask ()
virtual bool isPending () const =0
 Indicates whether this task has any pending work that needs to be done, if not then it is skipped and the next Task in the CompositeTaskRunner's list of tasks is checked, if none of the tasks have any pending work to do, then the runner can go to sleep until it awakened by a call to wakeup.
- Public Member Functions inherited from activemq::threads::Task
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 single task that can be part of a set of Tasks that are contained in a CompositeTaskRunner.

Since
3.0

Constructor & Destructor Documentation

virtual activemq::threads::CompositeTask::~CompositeTask ( )
virtual

Member Function Documentation

virtual bool activemq::threads::CompositeTask::isPending ( ) const
pure virtual

Indicates whether this task has any pending work that needs to be done, if not then it is skipped and the next Task in the CompositeTaskRunner's list of tasks is checked, if none of the tasks have any pending work to do, then the runner can go to sleep until it awakened by a call to wakeup.

Since
3.0

Implemented in activemq::transport::failover::FailoverTransport, activemq::transport::failover::BackupTransportPool, and activemq::transport::failover::CloseTransportsTask.


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