AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code

◆ Exit()

virtual DcppHandlerRet GitTask::Exit ( StatusType *  status,
GitTaskResponseHandler responseHandler = 0,
bool  freeResponse = false 
)
virtual

Cause a GIT task to exit.

This method sends the EXIT action to the task

This function returns DcppReschedule if it sent a message. In that case, replies are expected and should be dispatched using DcppDispatch() when they arrive. This will ensure that future processing occurs correctly and the the appropaite handler is invoked when the operation completes.

Note
This operation may return DcppFinished with status ok. This will occur if as a result of sub-classing no messages are sent.
If status is set bad on the call (as against during processing of responses, then the response handler is not invoked.
Parameters
statusInherited status
responseHandlerIf non-null, then this is the address of an object which is notified of the completion of the exit sequence. The GitTaskResponseHandler::CompleteOk method will be invoked on successfull completion of exit whilst GitTaskResponseHandler::CompleteWithError will be invoked if exit operation fails.
freeResponseIf set true, then the response handler is deleted just after the ok or error completion handler is invoked.