S60 3rd Edition API Reference: CSIPClientTransaction Class Reference

CSIPClientTransaction Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <sipclienttransaction.h>

Inherits CSIPTransactionBase.

Detailed Description

PublishedAll
Released
Class for managing SIP client transactions. It provides services for ending and getting the SIP client transaction parameters. Some client transactions can also be canceled.

The user of the class cannot instante this class.


Public Member Functions

IMPORT_C ~CSIPClientTransaction ()
 Destructor.
IMPORT_C const CSIPResponseElements * ResponseElements () const
 Gets response elements of the most recent response.
IMPORT_C CSIPClientTransaction * CancelL ()
 Cancels client transaction i.e.
IMPORT_C const CSIPRefresh * Refresh () const
 Gets the associated refresh with the transaction.
virtual IMPORT_C TBool CancelAllowed () const
 Checks if the client transaction is such that it can be cancelled.
CSIPRefresh * Refresh ()
 Gets the associated refresh with the transaction and allows modification fo the refresh.
void RemoveRefresh ()
 Clears the association from ClientTransaction to CSIPRefresh.

Static Public Member Functions

static CSIPClientTransaction * NewL (RStringF aType, TUint32 aRequestId, MTransactionAssociation &aAssociation, CSIPRefresh *aRefresh=0)
 Instantiates a CSIPClientTransaction object, leaves on failure.
static CSIPClientTransaction * NewLC (RStringF aType, TUint32 aRequestId, MTransactionAssociation &aAssociation, CSIPRefresh *aRefresh=0)
 Instantiates a CSIPClientTransaction object and pushes it into CleanupStack, leaves on failure.

Protected Member Functions

 CSIPClientTransaction (TUint32 aRequestId, MTransactionAssociation &aAssociation, CSIPRefresh *aRefresh)

Constructor & Destructor Documentation

IMPORT_C CSIPClientTransaction::~CSIPClientTransaction (   ) 
 

Destructor.

CSIPClientTransaction::CSIPClientTransaction ( TUint32  aRequestId,
MTransactionAssociation &  aAssociation,
CSIPRefresh *  aRefresh
)  [protected]
 

Member Function Documentation

virtual IMPORT_C TBool CSIPClientTransaction::CancelAllowed (   )  const [virtual]
 

Checks if the client transaction is such that it can be cancelled.

This does no check whether the transaction is currently in such a state that the canceling can be done now.

Returns:
ETrue if client transaction can be cancelled; EFalse otherwise
IMPORT_C CSIPClientTransaction* CSIPClientTransaction::CancelL (   ) 
 

Cancels client transaction i.e.

creates a CANCEL request and sends it to the remote UA.

Precondition:
State()==EProceeding

CancelAllowed()==ETrue

Connection().State()==EActive

Returns:
SIP CANCEL transaction, ownership is transferred.
Leave:
KErrSIPInvalidTransactionState if canceling is not possible at all, or because the transaction is not in a proper state or the transaction is not related to a dialog.
Leave:
KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted NetworkServices
static CSIPClientTransaction* CSIPClientTransaction::NewL ( RStringF  aType,
TUint32  aRequestId,
MTransactionAssociation &  aAssociation,
CSIPRefresh *  aRefresh = 0
)  [static]
 

Instantiates a CSIPClientTransaction object, leaves on failure.

Parameters:
aType Identifies the transaction type
aRequestId RequestId obtained from SIP client
aAssociation Object to which the transaction is associated with.
aRefresh If transaction is refreshed, this points to a CSIPRefresh, otherwise this is NULL. Ownership is not transferred.
Returns:
SIP client transaction, ownership is transferred.
static CSIPClientTransaction* CSIPClientTransaction::NewLC ( RStringF  aType,
TUint32  aRequestId,
MTransactionAssociation &  aAssociation,
CSIPRefresh *  aRefresh = 0
)  [static]
 

Instantiates a CSIPClientTransaction object and pushes it into CleanupStack, leaves on failure.

Parameters:
aType Identifies the transaction type
aRequestId RequestId obtained from SIP client
aAssociation Object to which the transaction is associated with.
aRefresh If transaction is refreshed, this points to a CSIPRefresh, otherwise this is NULL. Ownership is not transferred.
Returns:
SIP client transaction, ownership is transferred.
CSIPRefresh* CSIPClientTransaction::Refresh (   ) 
 

Gets the associated refresh with the transaction and allows modification fo the refresh.

This method is for internal use only.

Returns:
associated refresh or 0-pointer if there's no associated refresh. Ownership isn't transferred.
IMPORT_C const CSIPRefresh* CSIPClientTransaction::Refresh (   )  const
 

Gets the associated refresh with the transaction.

If the refresh is associated with the transaction, transaction will be refreshed at defined interval.

Returns:
associated refresh or 0-pointer if there's no associated refresh. Ownership isn't transferred.
void CSIPClientTransaction::RemoveRefresh (   ) 
 

Clears the association from ClientTransaction to CSIPRefresh.

IMPORT_C const CSIPResponseElements* CSIPClientTransaction::ResponseElements (   )  const
 

Gets response elements of the most recent response.

Returns:
Response elements. Ownership isn't transferred.

Reimplemented from CSIPTransactionBase.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top