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

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 DcppVoidPnt ClientData=0)
 Constructor for normal transactions. More...
 
 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. More...
 
int check () const
 Check indicates if the check value is correct. More...
 
DcppHandlerRoutine SuccessHandler () const
 Returns the success handler routine. More...
 
DcppHandlerRoutine TriggerHandler () const
 Returns the trigger handler routine. More...
 
DcppHandlerRoutine ErrorHandler () const
 Returns the Error handler routine. More...
 
DcppHandlerRoutine ErsHandler () const
 Return the Ers handler routine. More...
 
DcppHandlerRoutine MsgHandler () const
 Return the MsgOut handler routine. More...
 
DcppBulkTransRoutine BulkTransHandler () const
 Return the bulk transfer message handler routine. More...
 
DcppHandlerRoutine BulkDoneHandler () const
 Return the bulkd transfer done message handler routine. More...
 
DcppVoidPnt ClientData () const
 Return the client data item. More...
 
DcppTaskTask () const
 Return the associated DcppTask object. More...
 
DcppHandlerRet HandleEvent (StatusType *const status)
 Handle the event. More...
 
bool Forgotten () const
 Indicate if the transaction was forgotten. More...
 
void Forget ()
 Forget the transaction. More...
 

Detailed Description

A type used to connect DcppHandler and DcppTask.

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

Constructor & Destructor Documentation

DcppTransaction::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 
)
inline

Constructor for normal transactions.

DcppTransaction::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 
)
inline

Constructor for bulk data transactions.

Member Function Documentation

DcppHandlerRoutine DcppTransaction::BulkDoneHandler ( ) const
inline

Return the bulkd transfer done message handler routine.

DcppBulkTransRoutine DcppTransaction::BulkTransHandler ( ) const
inline

Return the bulk transfer message handler routine.

int DcppTransaction::check ( ) const
inline

Check indicates if the check value is correct.

References DcppCheckData.

DcppVoidPnt DcppTransaction::ClientData ( ) const
inline

Return the client data item.

DcppHandlerRoutine DcppTransaction::ErrorHandler ( ) const
inline

Returns the Error handler routine.

DcppHandlerRoutine DcppTransaction::ErsHandler ( ) const
inline

Return the Ers handler routine.

void DcppTransaction::Forget ( )
inline

Forget the transaction.

bool DcppTransaction::Forgotten ( ) const
inline

Indicate if the transaction was forgotten.

DcppHandlerRet DcppTransaction::HandleEvent ( StatusType *const  status)

Handle the event.

DcppHandlerRoutine DcppTransaction::MsgHandler ( ) const
inline

Return the MsgOut handler routine.

DcppHandlerRoutine DcppTransaction::SuccessHandler ( ) const
inline

Returns the success handler routine.

DcppTask* DcppTransaction::Task ( ) const
inline

Return the associated DcppTask object.

DcppHandlerRoutine DcppTransaction::TriggerHandler ( ) const
inline

Returns the trigger handler routine.


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@aao.gov.au 

Generated on Mon Feb 22 2016 13:58:31 for AAO DRAMA C++ Interfaces by doxygen 1.8.10