DRAMA C++ Intro   Class Hierarchy   Alphabetical List of types   List of Classes   File List   Class Member Index   File Members Index   Related Pages  

GitTaskResponseHandler Class Reference

#include <gittask.h>

List of all members.


Detailed Description

Base object used to handle reponses to the GitTask messages.

Object of this type are used to handle responses to messages sent by GitTask. This class should sub-classed by the user such that their application can be notified of the relevant events.


Public Methods

 GitTaskResponseHandler ()
 Constructor.

virtual DcppHandlerRet CompleteOk (GitTask *task, StatusType *status)
 Method invoked on successfull completion.

virtual DcppHandlerRet CompleteWithError (GitTask *task, StatusType *status)
 Method invoked on error completion.

virtual DcppHandlerRet Triggered (GitTask *task, StatusType *status)
 Method invoked on reception of a trigger message.

virtual ~GitTaskResponseHandler ()
 Destructor.


Constructor & Destructor Documentation

GitTaskResponseHandler::GitTaskResponseHandler   [inline]
 

Constructor.

virtual GitTaskResponseHandler::~GitTaskResponseHandler   [inline, virtual]
 

Destructor.


Member Function Documentation

virtual DcppHandlerRet GitTaskResponseHandler::CompleteOk GitTask   task,
StatusType *    status
[inline, virtual]
 

Method invoked on successfull completion.

This method is invoked by GitTask:: when the releated message completes successfull.

Note:
Details of action entry information can be obtain with the standard DRAMA calls such as DitsGetEntReason().
Returns:
DcppFinished (the default) if no more messages were sent or DcppReshedule if another message was started.
Parameters:
task  The GitTask object the message referred to.
status  Inherited status.

virtual DcppHandlerRet GitTaskResponseHandler::CompleteWithError GitTask   task,
StatusType *    status
[inline, virtual]
 

Method invoked on error completion.

This method is invoked by GitTask:: when the releated message completes with an error.

Note:
Details of action entry information can be obtain with the standard DRAMA calls such as DitsGetEntReason().
The status of the failure is available in DitsGetEntStatus(), not from the inherited status, through the default implementation sets the inherited status to this value.
Returns:
DcppFinished (the default) if no more messages were sent or DcppReshedule if another message was started.
Parameters:
task  The GitTask object the message referred to.
status  Inherited status.

virtual DcppHandlerRet GitTaskResponseHandler::Triggered GitTask   task,
StatusType *    status
[inline, virtual]
 

Method invoked on reception of a trigger message.

This method is invoked by GitTask:: when the releated message gets a trigger message reply..

Note:
Details of action entry information can be obtain with the standard DRAMA calls such as DitsGetEntReason().
Returns:
Should return DcppReschedule unless you wish the action to complete now.
Parameters:
task  The GitTask object the message referred to.
status  Inherited status.


The documentation for this class was generated from the following file:

Click here for the DRAMA home page and here for the AAO home page.

For more information, contact tjf@aaoepp.aao.gov.au 

Generated on Tue Nov 3 09:09:56 2009 for AAO DRAMA C++ Interfaces by doxygen 1.2.18