activemq::transport::failover::CloseTransportsTask Class Reference
#include <src/main/activemq/transport/failover/CloseTransportsTask.h>
Inheritance diagram for activemq::transport::failover::CloseTransportsTask:
Public Member Functions | |
| CloseTransportsTask () | |
| virtual | ~CloseTransportsTask () |
| void | add (const Pointer< Transport > transport) |
| Add a new Transport to close. | |
| virtual bool | isPending () const |
| This Task is pending if there are transports in the Queue that need to be closed. | |
| virtual bool | iterate () |
| Return true until all transports have been closed and removed from the queue. | |
 Public Member Functions inherited from activemq::threads::CompositeTask | |
| 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. | |
Constructor & Destructor Documentation
◆ CloseTransportsTask()
| activemq::transport::failover::CloseTransportsTask::CloseTransportsTask | ( | ) |
◆ ~CloseTransportsTask()
|
virtual |
Member Function Documentation
◆ add()
| void activemq::transport::failover::CloseTransportsTask::add | ( | const Pointer< Transport > | transport | ) |
Add a new Transport to close.
◆ isPending()
|
virtual |
This Task is pending if there are transports in the Queue that need to be closed.
- Returns
- true if there is a transport in the queue that needs closed.
Implements activemq::threads::CompositeTask.
◆ iterate()
|
virtual |
Return true until all transports have been closed and removed from the queue.
Implements activemq::threads::Task.
The documentation for this class was generated from the following file:
- src/main/activemq/transport/failover/CloseTransportsTask.h
