CProtTransaction Class Reference

#include <mw/http/framework/cprottransaction.h>

class CProtTransaction : public CBase

Inherits from

  • CProtTransaction
    Protected Attributes
    CRxData *iRxData
    RHTTPTransaction iTrans
    TTransactionState iTransactionState
    CTxData *iTxData
    Public Member Enumerations
    enumTTransactionState { EPending, EActive, ECancelled, ECompleted }
    Public Member Functions
    virtual ~CProtTransaction()
    pure virtual voidCreateRxDataL(MRxDataObserver &)
    pure virtual voidCreateTxDataL()
    IMPORT_C voidResetRxData()
    IMPORT_C voidResetTxData()
    IMPORT_C CRxData &RxData()
    voidSetTransactionState(TTransactionState)
    IMPORT_C RHTTPTransactionTransaction()
    TTransactionState TransactionState()
    IMPORT_C CTxData &TxData()
    Protected Member Functions
    CProtTransaction()
    CProtTransaction(RHTTPTransaction)
    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()

    Detailed 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.

    Member Attribute Documentation

    iRxData

    CRxData *iRxData[protected]

    The received data

    iTrans

    RHTTPTransaction iTrans[protected]

    The client transaction

    iTransactionState

    TTransactionState iTransactionState[protected]

    Transaction state indicator.

    iTxData

    CTxData *iTxData[protected]

    The transmission data

    Member Enumeration Documentation

    Enum TTransactionState

    The TTransactionState type defines the states of a transaction.

    EnumeratorValueDescription
    EPending0

    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.

    Constructor & Destructor Documentation

    CProtTransaction ( )

    CProtTransaction()[protected]

    Default constructor

    CProtTransaction ( RHTTPTransaction )

    IMPORT_CCProtTransaction(RHTTPTransactionaTrans)[protected]

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

    ParameterDescription
    aTrans(in) The client transaction handle.

    ~CProtTransaction ( )

    IMPORT_C~CProtTransaction()[virtual]

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

    Member Function Documentation

    CreateRxDataL ( MRxDataObserver & )

    voidCreateRxDataL(MRxDataObserver &aObserver)[pure virtual]
    Intended Usage: Creates the appropriate CRxData object.
    leave
    KErrNoMemory if there is not enough memory available to create the object.
    ParameterDescription
    aObserverA reference to the observer for the Rx data object.

    CreateTxDataL ( )

    voidCreateTxDataL()[pure virtual]
    Intended Usage: Creates the appropriate CTxData object.
    leave
    KErrNoMemory if there is not enough memory available to create the object.

    ResetRxData ( )

    IMPORT_C voidResetRxData()
    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 voidResetTxData()
    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

    Returns: A reference to the Rx data object of the transaction.reference to CRxData object that contains received Data portion of the transaction.

    SetTransactionState ( TTransactionState )

    voidSetTransactionState(TTransactionStateaState)
    Sets the state of the transaction.
    Post-condition
    The state of the transaction has been updated.
    ParameterDescription
    aStateThe state that the transaction is in.

    Transaction ( )

    IMPORT_C RHTTPTransactionTransaction()const

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

    Returns: The API-level transaction that this object corresponds to.a RHTTPTransaction object which represents the transaction to which this object corresponds.

    TransactionState ( )

    TTransactionState TransactionState()const

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

    Returns: A enum specifying the state of the transaction.

    TxData ( )

    IMPORT_C CTxData &TxData()const

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

    Returns: A reference to the Tx data object of the transaction.reference to CTxData object that contains transmit Data portion of the transaction.

    © Nokia 2011.