AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ ActionEnd()

virtual void drama::MessageHandler::ActionEnd ( bool  taskExiting,
StatusType  actionEndStatus 
)
protectedvirtualinherited

Method Invoked when the action completes.

A default implementation of an action end method, invoked when the action ends, whatever the reason. The user should override this if they want to be notified about the action completing.

This method is only invoked for objects specified to a Task::Add method, or returned by drama::Spawnable::Spawn.

This method is called after any bulk data has tidied up but before any remaining ERS messages are flushed (so they can be annulled or added to) and before the action completion message is returned to the parent task.

The MessageHandler::GetTask() method will be valid during this method.

Warning
This is a private member, not a protected member. Doxygen sees this as protected to work around a Doxygen issue.
Parameters
taskExitingWill be true if being invoked as the task exits.
actionEndStatusThe final DRAMA status code of the action.