Class CSIPServerTransaction

class CSIPServerTransaction : public CSIPTransactionBase;

Description

Class for managing SIP server transactions. It provides services for creating, ending and getting SIP transaction parameters. Client cannot instantiate this class.

sipclient

Derivation

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

• CSIPTransactionBase - Base class for managing SIP transactions

• CSIPServerTransaction - Class for managing SIP server transactions

Members

Defined in CSIPServerTransaction:
RequestElements(), ResponseAllowed(), SendResponseL(), ~CSIPServerTransaction()

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

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

IMPORT_C ~CSIPServerTransaction();

Description

Destructor

Capability:

NetworkServices

IMPORT_C void SendResponseL(CSIPResponseElements *aElements);

Pre-Condition

aElements!=0

State()==ETrying || State()==EProceeding

CSIPConnection::State()==EActive

ResponseAllowed()==ETrue

Description

Sends response and ends the transaction; The user must not send 100 Trying response. Leaves on failure.

Parameters

CSIPResponseElements *aElements contains Status Code, optional Reason Phrase and optional SIP message headers and body. Ownership is transferred.

Leave codes

KErrArgument if aElements == NULL KErrGeneral if ResponseAllowed() == EFalse KErrSIPInvalidTransactionState if State()!=ETrying and State()!=EProceeding KErrSIPInvalidDialogState if sending response to a request within dialog, and the dialog is in terminated state. KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted

IMPORT_C const CSIPRequestElements *RequestElements() const;

Description

Gets the request elements

Return value

const CSIPRequestElements * Request elements. Ownership is not transferred.

IMPORT_C TBool ResponseAllowed() const;

Description

Checks if the response sending is allowed for this server transaction. For instance response is not allowed in ACK transaction.

Return value

TBool ETrue if response sending is allowed, EFalse otherwise