Class CProtTransaction

class CProtTransaction : public CBase;

Description

A representation of a transaction used by protocol handlers. This class is lower-level than the RHTTPTransaction class, since it owns objects that represent the request and response data as transmitted and received over a transport medium.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CProtTransaction - A representation of a transaction used by protocol handlers

Members

Defined in CProtTransaction:
CProtTransaction(), CreateRxDataL(), CreateTxDataL(), EActive, ECancelled, ECompleted, EPending, Reserved1(), Reserved2(), ResetRxData(), ResetTxData(), RxData(), TTransactionState, Transaction(), TxData(), iRxData, iTrans, iTransactionState, iTxData, ~CProtTransaction()

Inherited from CBase:
Delete(), Extension_(), operator new()

virtual IMPORT_C ~CProtTransaction();

Description

Destructor - cleans up and releases resources to the system.

Intended Usage: Destructor - cleans up and releases resources to the system

protected: IMPORT_C CProtTransaction(RHTTPTransaction aTrans);

Description

Normal constructor, of a CProtTransaction that corresponds to the supplied client transaction handle.

Parameters

RHTTPTransaction aTrans (in) The client transaction handle.

IMPORT_C void ResetRxData();

Description

Resets the Rx data object. The Rx data object must be created again to be used.

Post-Condition

The Rx data objects has been reset.

IMPORT_C void ResetTxData();

Description

Resets the Tx data object. The Tx data object must be created again to be used.

Post-Condition

The Tx data objects has been reset.

IMPORT_C RHTTPTransaction Transaction() const;

Description

Obtain the API-level transaction to which this object corresponds to.

Return value

RHTTPTransaction The API-level transaction that this object corresponds to.

IMPORT_C CTxData &TxData() const;

Description

Obtain the Transmit Data portion of the transaction.

Return value

CTxData & A reference to the Tx data object of the transaction.

IMPORT_C CRxData &RxData() const;

Description

Obtain the Receive Data portion of the transaction.

Return value

CRxData & A reference to the Rx data object of the transaction.

virtual void CreateTxDataL()=0;

Description

Intended Usage: Creates the appropriate CTxData object.

Leave codes

KErrNoMemory if there is not enough memory available to create the object.

virtual void CreateRxDataL(MRxDataObserver &aObserver)=0;

Description

Intended Usage: Creates the appropriate CRxData object.

Parameters

MRxDataObserver &aObserver A reference to the observer for the Rx data object.

Leave codes

KErrNoMemory if there is not enough memory available to create the object.

private: inline virtual void Reserved1();

Description

Intended Usage: Reserve a slot in the v-table to preserve future BC

private: inline virtual void Reserved2();

Description

Intended Usage: Reserve a slot in the v-table to preserve future BC

TTransactionState

Description

The TTransactionState type defines the states of a transaction.

EPending Specifies that the transaction is pending servicing. EActive Specifies that the transaction is being serviced - active. ECancelled Specifies that the transaction has been cancelled. ECompleted Specifies that the transaction has completed.

protected: RHTTPTransaction iTrans;

Description

The client transaction

protected: CTxData * iTxData;

Description

The transmission data

protected: CRxData * iRxData;

Description

The received data

protected: TTransactionState iTransactionState;

Description

Transaction state indicator.