Class CSIPClientTransaction

class CSIPClientTransaction : public CSIPTransactionBase;

Description

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

Derivation

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

• CSIPTransactionBase - Base class for managing SIP transactions

• CSIPClientTransaction - Class for managing SIP client transactions

Members

Defined in CSIPClientTransaction:
CancelAllowed(), CancelL(), Refresh(), ResponseElements(), ~CSIPClientTransaction()

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

Inherited from CSIPTransactionBase:
ECalling, ECompleted, EConfirmed, EConstructing, EProceeding, ETerminated, ETrying, IsSIPClientTransaction(), StateL(), TState, Type(), operator==()

IMPORT_C ~CSIPClientTransaction();

Description

Destructor

IMPORT_C const CSIPResponseElements *ResponseElements() const;

Description

Gets response elements of the most recent response.

Return value

const CSIPResponseElements * Response elements. Ownership isn't transferred.

Capability:

NetworkServices

IMPORT_C CSIPClientTransaction *CancelL();

Pre-Condition

State()==EProceeding

CancelAllowed()==ETrue

Connection().State()==EActive

Description

Cancels client transaction i.e. creates a CANCEL request and sends it to the remote UA.

Return value

CSIPClientTransaction * SIP CANCEL transaction, ownership is transferred.

Leave codes

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. KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted

IMPORT_C const CSIPRefresh *Refresh() const;

Description

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

Return value

const CSIPRefresh * associated refresh or 0-pointer if there's no associated refresh. Ownership isn't transferred.

virtual IMPORT_C TBool CancelAllowed() const;

Description

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.

Return value

TBool ETrue if client transaction can be cancelled; EFalse otherwise