AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code
Public Member Functions | List of all members
DcppTransaction Class Reference

A type used to connect DcppHandler and DcppTask. More...

#include <dcpp.h>

Public Member Functions

 DcppTransaction (DcppTask *Task, const DcppHandlerRoutine Success=0, const DcppHandlerRoutine Error=0, const DcppHandlerRoutine Trigger=0, const DcppHandlerRoutine Ers=0, const DcppHandlerRoutine Msg=0, const DcppBulkTransRoutine BulkTrans=0, const DcppHandlerRoutine BulkDone=0, const DcppVoidPnt ClientData=0)
 Constructor for bulk data transactions.
 
 DcppTransaction (DcppTask *Task, const DcppHandlerRoutine Success=0, const DcppHandlerRoutine Error=0, const DcppHandlerRoutine Trigger=0, const DcppHandlerRoutine Ers=0, const DcppHandlerRoutine Msg=0, const DcppVoidPnt ClientData=0)
 Constructor for normal transactions.
 
DcppHandlerRoutine BulkDoneHandler () const
 Return the bulkd transfer done message handler routine.
 
DcppBulkTransRoutine BulkTransHandler () const
 Return the bulk transfer message handler routine.
 
int check () const
 Check indicates if the check value is correct

 
DcppVoidPnt ClientData () const
 Return the client data item.
 
DcppHandlerRoutine ErrorHandler () const
 Returns the Error handler routine.
 
DcppHandlerRoutine ErsHandler () const
 Return the Ers handler routine.
 
void Forget ()
 Forget the transaction.
 
bool Forgotten () const
 Indicate if the transaction was forgotten.
 
DcppHandlerRet HandleEvent (StatusType *const status)
 Handle the event.
 
DcppHandlerRoutine MsgHandler () const
 Return the MsgOut handler routine.
 
DcppHandlerRoutine SuccessHandler () const
 Returns the success handler routine.
 
DcppTaskTask () const
 Return the associated DcppTask object.
 
DcppHandlerRoutine TriggerHandler () const
 Returns the trigger handler routine.
 

Detailed Description

A type used to connect DcppHandler and DcppTask.

This type keeps track of transactions. It is used internally by DcppTask and DcppHandler.


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