CSIPReferDialogAssoc Class Reference
#include
<mw/sipreferdialogassoc.h>
Link against: sipclient.lib
| class CSIPReferDialogAssoc : public CSIPDialogAssocBase |
| Public Member Functions |
|---|
| ~CSIPReferDialogAssoc() |
|
CSIPClientTransaction * | DoSendReferL(CSIPMessageElements *, TBool) |
| IMPORT_C CSIPReferDialogAssoc * | NewL(CSIPDialog &, CSIPReferToHeader *) |
| IMPORT_C CSIPReferDialogAssoc * | NewL(CSIPConnection &, CSIPFromHeader *, CUri8 *, CSIPReferToHeader *, CSIPToHeader *, CSIPContactHeader *) |
| IMPORT_C CSIPReferDialogAssoc * | NewL(CSIPConnection &, CUri8 *, const MSIPRegistrationContext &, CSIPReferToHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader *) |
| IMPORT_C CSIPReferDialogAssoc * | NewLC(CSIPDialog &, CSIPReferToHeader *) |
| IMPORT_C CSIPReferDialogAssoc * | NewLC(CSIPConnection &, CSIPFromHeader *, CUri8 *, CSIPReferToHeader *, CSIPToHeader *, CSIPContactHeader *) |
| IMPORT_C CSIPReferDialogAssoc * | NewLC(CSIPConnection &, CUri8 *, const MSIPRegistrationContext &, CSIPReferToHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader *) |
| IMPORT_C const CSIPReferToHeader & | ReferTo() |
| IMPORT_C CSIPClientTransaction * | SendReferL(CSIPMessageElements *) |
| 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() |
| | CSIPDialogAssocBase::CSIPDialogAssocBase() |
| | CSIPDialogAssocBase::ConstructL(RStringF,CSIPDialog &) |
| | CSIPDialogAssocBase::ConstructL(RStringF,CSIPDialog &,CSIPServerTransaction &) |
| | CSIPDialogAssocBase::DeletingRefresh(CSIPRefresh &,TUint32) |
| | CSIPDialogAssocBase::Dialog() |
| | CSIPDialogAssocBase::Dialog()const |
| | CSIPDialogAssocBase::FindRefresh(TUint32) |
| | CSIPDialogAssocBase::Implementation() |
| | CSIPDialogAssocBase::IsNonTargetRefreshRequest(RStringF)const |
| | CSIPDialogAssocBase::SendNonTargetRefreshRequestL(RStringF,CSIPMessageElements *) |
| | CSIPDialogAssocBase::Type()const |
| | CSIPDialogAssocBase::~CSIPDialogAssocBase() |
Detailed Description
Class for managing SIP REFER dialog associations. It provides services for creating, using and terminating SIP REFER dialog associations. User can have multiple REFER dialog associations per same SIP dialog. Implementation handles SUBSCRIBE on the dialog level defined by Call-Id, local and remote tags; User is responsible for "Refer-to" header semantics.
Constructor & Destructor Documentation
~CSIPReferDialogAssoc ( )
| IMPORT_C | ~CSIPReferDialogAssoc | ( | ) | |
Member Function Documentation
DoSendReferL ( CSIPMessageElements *, TBool )
Sends a REFER request.
- Pre-condition
-
Dialog().Connection().State()==EActive
| Parameter | Description | | aElements | optional SIP message headers and body. Ownership is transferred. |
| aWithinDialog | ETrue if REFER is sent within dialog, EFalse if REFER creates the dialog. |
Returns: REFER SIP transaction. Ownership is transferred.
NewL ( CSIPDialog &, CSIPReferToHeader * )
Two-phased constructor. Should be used if response to the SIP request to be sent will create a SIP dialog association.
- Pre-condition
- aReferTo != 0
- leave
- KErrArgument if aReferTo == 0
| Parameter | Description | | aDialog | a dialog to be associated with |
| aReferTo | referred-to resource; Ownership is transferred |
Returns: New object; the ownership is transferred
NewL ( CSIPConnection &, CSIPFromHeader *, CUri8 *, CSIPReferToHeader *, CSIPToHeader *, CSIPContactHeader * )
Two-phased constructor
- Pre-condition
- aFrom != 0
aReferTo != 0 aRemoteUri != 0 The user of the class must not define tags in From-header and To-header.
- leave
- KErrArgument if aFrom == 0 or aRemoteuri == 0 or aReferTo == 0
| Parameter | Description | | aConnection | a SIP connection to be used with dialog association |
| aFrom | originator's address; the ownership is transfered |
| aRemoteUri | a remote target URI that identifies a resource that the request is addressed to. |
| aReferTo | referred-to resource; Ownership is transferred |
| aTo | logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered |
| aContact | a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered |
Returns: New object; the ownership is transferred.
NewL ( CSIPConnection &, CUri8 *, const MSIPRegistrationContext &, CSIPReferToHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader * )
Two-phased constructor
- Pre-condition
- aReferTo != 0
aRemoteUri != 0 The user of the class must not define tags in From-header and To-header. aContext.IsContextActive() == ETrue
- leave
- KErrArgument if aRemoteuri == 0 or aReferTo == 0
- leave
- KErrSIPInvalidRegistrationState if aContext.IsContextActive() == EFalse
| Parameter | Description | | aConnection | a SIP connection to be used with dialog association |
| aRemoteUri | a remote target URI that identifies a resource that the request is targeted to. |
| aContext | used for selecting outbound proxy and originator's address (AOR) and contact |
| aReferTo | referred-to resource; Ownership is transferred |
| aFrom | originator's address. If not defined it will constructed using registration context (User's AOR); the ownership is transfered |
| aTo | logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered |
| aContact | a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered |
Returns: New object: the ownership is transferred.
NewLC ( CSIPDialog &, CSIPReferToHeader * )
Two-phased constructor. Must be used if response to the SIP request to be sent will create a SIP dialog association.
- Pre-condition
- aReferTo != 0
- leave
- KErrArgument if aReferTo == 0
| Parameter | Description | | aDialog | a dialog to be associated with |
| aReferTo | referred-to resource; Ownership is transferred |
Returns: New object; the ownership is transferred
NewLC ( CSIPConnection &, CSIPFromHeader *, CUri8 *, CSIPReferToHeader *, CSIPToHeader *, CSIPContactHeader * )
Two-phased constructor
- Pre-condition
- aFrom != 0
aReferTo != 0 aRemoteUri != 0 The user of the class must not define tags in From-header and To-header.
- leave
- KErrArgument if aFrom == 0 or aRemoteuri == 0 or aReferTo == 0
| Parameter | Description | | aConnection | a SIP connection to be used with dialog association |
| aFrom | originator's address; the ownership is transfered |
| aRemoteUri | a remote target URI that identifies a resource that the request is addressed to. |
| aReferTo | referred-to resource; Ownership is transferred |
| aTo | logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered |
| aContact | a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered |
Returns: New object; the ownership is transferred.
NewLC ( CSIPConnection &, CUri8 *, const MSIPRegistrationContext &, CSIPReferToHeader *, CSIPFromHeader *, CSIPToHeader *, CSIPContactHeader * )
Two-phased constructor
- Pre-condition
- aReferTo != 0
aRemoteUri != 0 The user of the class must not define tags in From-header and To-header. aContext.IsContextActive()==ETrue
- leave
- KErrArgument if aRemoteuri == 0 or aReferTo == 0
- leave
- KErrSIPInvalidRegistrationState if aContext.IsContextActive() == EFalse
| Parameter | Description | | aConnection | a SIP connection to be used with dialog association |
| aRemoteUri | a remote target URI that identifies a resource that the request is targeted to. |
| aContext | used for selecting outbound proxy and originator's address (AOR) and contact |
| aReferTo | referred-to resource; Ownership is transferred |
| aFrom | originator's address. If not defined it will constructed using registration context (User's AOR); the ownership is transfered |
| aTo | logical recipient's address; if not defined the remote target uri will be used for To-header construction; the ownership is transfered |
| aContact | a contact to be used in dialog creation. Must be given only if user intends to re-direct future requests; the ownership is transfered |
Returns: New object; the ownership is transferred.
ReferTo ( )
Returns: referred-to resource
SendReferL ( CSIPMessageElements * )
Creates REFER and sends it to the remote target. leaves on failure. 101-199 or 2xx response will create REFER dialog association in case of first REFER request within this dialog association.
- Pre-condition
- Dialog().Connection().State()==EActive
Dialog().State()==CSIPDialogEInit || Dialog().State()==CSIPDialogEConfirmed
- leave
- KErrSIPInvalidDialogState if dialog is in wrong state
- leave
- KErrSIPResourceNotAvailable if a required SIP Client API object has been deleted.
- capability
- NetworkServices
| Parameter | Description | | aElements | optional SIP message headers and body. Ownership is transferred. |
Returns: REFER SIP transaction. Ownership is transferred.