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

◆ PollSignalEvent()

virtual void drama::git::Task::PollSignalEvent ( MessageHandler messageHandler)
virtual

Poll action signal event handler.

This method is invoked if the POLL action receives a signal event, but only if PollObeyOverride() returned false.

Signal events are one of the most common events for poll handlers to be interested in, so this handler allows a sub-class to override the behavior without having to do all the work needed if it were to use PollObeyOverride().

The default implementation does nothing but report a message to the user.

Parameters
messageHandlerThe POLL kick message handler. An implementer can access the reason for the entry using messageHandler->GetEntry(), output messages using messageHandler->MessageUser() etc.