Collapse all Symbian^3 Application Developer Library

CProtTransaction Class Reference

class CProtTransaction : public CBase

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.

Inherits from

CProtTransaction
- CBase

Public Member Functions
	~CProtTransaction ()
void	CreateRxDataL ( MRxDataObserver &)
void	CreateTxDataL ()
IMPORT_C void	ResetRxData ()
IMPORT_C void	ResetTxData ()
IMPORT_C CRxData &	RxData ()
void	SetTransactionState ( TTransactionState )
IMPORT_C RHTTPTransaction	Transaction ()
TTransactionState	TransactionState ()
IMPORT_C CTxData &	TxData ()

Protected Member Functions
	CProtTransaction ()
	CProtTransaction ( RHTTPTransaction )

Private Member Functions
void	Reserved1 ()
void	Reserved2 ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TTransactionState { EPending = 0, EActive , ECancelled , ECompleted }

Protected Attributes
CRxData *	iRxData
RHTTPTransaction	iTrans
TTransactionState	iTransactionState
CTxData *	iTxData

Constructor & Destructor Documentation

CProtTransaction()

CProtTransaction

(

)

[protected]

Default constructor

CProtTransaction(RHTTPTransaction)

IMPORT_C

CProtTransaction

(

RHTTPTransaction

aTrans

)

[protected]

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

Parameters

RHTTPTransaction aTrans

(in) The client transaction handle.

~CProtTransaction()

IMPORT_C

~CProtTransaction

(

)

[virtual]

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

Member Functions Documentation

CreateRxDataL(MRxDataObserver &)

void

CreateRxDataL

(

MRxDataObserver &

aObserver

)

[pure virtual]

Intended Usage: Creates the appropriate CRxData object.

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

Parameters

MRxDataObserver & aObserver

A reference to the observer for the Rx data object.

CreateTxDataL()

void

CreateTxDataL

(

)

[pure virtual]

Intended Usage: Creates the appropriate CTxData object.

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

Reserved1()

void

Reserved1

(

)

[private, inline, virtual]

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

Reserved2()

void

Reserved2

(

)

[private, inline, virtual]

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

ResetRxData()

IMPORT_C void

ResetRxData

(

)

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

(

)

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.

RxData()

IMPORT_C CRxData &

RxData

(

)

const

Obtain the Receive Data portion of the transaction. Obtain the Received Data portion of the transaction

SetTransactionState(TTransactionState)

void

SetTransactionState

(

TTransactionState

aState

)

Sets the state of the transaction.

Post-condition: The state of the transaction has been updated.

Parameters

TTransactionState aState

The state that the transaction is in.

Transaction()

IMPORT_C RHTTPTransaction

Transaction

(

)

const

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

TransactionState()

TTransactionState

TransactionState

(

)

const

Provides the state of the transaction, e.g. pending, active, etc.

TxData()

IMPORT_C CTxData &

TxData

(

)

const

Obtain the Transmit Data portion of the transaction. Obtain the Transmit Data portion of the transaction

Member Enumerations Documentation

Enum TTransactionState

The TTransactionState type defines the states of a transaction.

Enumerators

EPending = 0	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 Documentation

CRxData * iRxData

CRxData *

iRxData

[protected]

The received data

RHTTPTransaction iTrans

RHTTPTransaction

iTrans

[protected]

The client transaction

TTransactionState iTransactionState

TTransactionState

iTransactionState

[protected]

Transaction state indicator.

CTxData * iTxData

CTxData *

iTxData

[protected]

The transmission data