---

DcppTransaction Class Reference

#include <dcpp.h>

List of all members.

---

Detailed Description

A type used to connect DcppHandler and DcppTask.

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

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

---

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.

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:

• dcpp.h

---