PollKick()

virtual bool drama::git::Task::PollKick ( MessageHandler *  messageHandler )

virtual

Poll action kick implementation.

This method allows the sub-class to override specific poll kick operations.

The default implementation does nothing but message the user and returns true, which would cause the POLL action to complete.

Warning - NOT threaded, so can't send messages using DRAMA2. If you need that ability, then you will need to implement an entirely new POLL action.

Note

This method is not intended to be called by user code, it must be public only because of the git::task implementation structure.

Control tasks expect that a POLL action completes when kicked. You should change this behavior only based on arguments to the kick, since the standard control tasks don't set any argument.

Parameters

messageHandler

The POLL kick message handler. An implementer can access the reason for the entry using messageHandler->GetEntry(), output messages using messageHandler->MessageUser(), and can access the argument using GetEntry.Argument().

Returns

Return true if the POLL action should complete, false if it should reschedule according to the POLL_PARAMETER value.