#include <CProtTransaction.h>
Link against: http.lib

This item is not part of the S60 5th Edition SDK

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. This class is lower...

Members

Defined in CProtTransaction:

CProtTransaction(RHTTPTransaction)Normal constructor, of a CProtTransaction that corresponds to the supplied clien...
CreateRxDataL(MRxDataObserver &)Intended Usage: Creates the appropriate CRxData object.
CreateTxDataL()Intended Usage: Creates the appropriate CTxData object.
EActiveSpecifies that the transaction is being serviced - active.
ECancelledSpecifies that the transaction has been cancelled.
ECompletedSpecifies that the transaction has completed.
EPendingSpecifies that the transaction is pending servicing.
Reserved1()Intended Usage: Reserve a slot in the v-table to preserve future BC
Reserved2()Intended Usage: Reserve a slot in the v-table to preserve future BC
ResetRxData()Resets the Rx data object. The Rx data object must be created again to be used.
ResetTxData()Resets the Tx data object. The Tx data object must be created again to be used.
RxData()constObtain the Receive Data portion of the transaction.
TTransactionStateThe TTransactionState type defines the states of a transaction.
Transaction()constObtain the API-level transaction to which this object corresponds to.
TxData()constObtain the Transmit Data portion of the transaction.
iRxDataThe received data
iTransThe client transaction
iTransactionStateTransaction state indicator.
iTxDataThe transmission data
~CProtTransaction()Destructor - cleans up and releases resources to the system.

Inherited from CBase:

Delete(CBase *)Deletes the specified object.
Extension_(TUint,TAny *&,TAny *)Extension function
operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TAny *)Initialises the object to binary zeroes.
operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Construction and destruction

`~CProtTransaction()`

IMPORT_C virtual ~CProtTransaction();

Description

Destructor - cleans up and releases resources to the system.

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

`CProtTransaction(RHTTPTransaction)`

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.

Member functions

`ResetRxData()`

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.

`ResetTxData()`

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.

`Transaction()const`

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.

`TxData()const`

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.

`RxData()const`

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.

`CreateTxDataL()`

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.

`CreateRxDataL(MRxDataObserver &)`

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.

`Reserved1()`

private: inline virtual void Reserved1();

Description

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

`Reserved2()`

private: inline virtual void Reserved2();

Description

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

Member enumerations

Enum `TTransactionState`

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.

Member data

`iTrans`

protected: RHTTPTransaction iTrans;

Description

The client transaction

`iTxData`

protected: CTxData * iTxData;

Description

The transmission data

`iRxData`

protected: CRxData * iRxData;

Description

The received data

`iTransactionState`

protected: TTransactionState iTransactionState;

Description

Transaction state indicator.

Class CProtTransaction

Description

Derivation

Members

Construction and destruction

~CProtTransaction()

Description

CProtTransaction(RHTTPTransaction)

Description

Parameters

Member functions

ResetRxData()

Description

Post-Condition

ResetTxData()

Description

Post-Condition

Transaction()const

Description

Return value

TxData()const

Description

Return value

RxData()const

Description

Return value

CreateTxDataL()

Description

Leave codes

CreateRxDataL(MRxDataObserver &)

Description

Parameters

Leave codes

Reserved1()

Description

Reserved2()

Description

Member enumerations

Enum TTransactionState

Description

Member data

iTrans

Description

iTxData

Description

iRxData

Description

iTransactionState

Description

Class `CProtTransaction`

`~CProtTransaction()`

`CProtTransaction(RHTTPTransaction)`

`ResetRxData()`

`ResetTxData()`

`Transaction()const`

`TxData()const`

`RxData()const`

`CreateTxDataL()`

`CreateRxDataL(MRxDataObserver &)`

`Reserved1()`

`Reserved2()`

Enum `TTransactionState`

`iTrans`

`iTxData`

`iRxData`

`iTransactionState`