williamr@2: /* williamr@2: * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: * All rights reserved. williamr@2: * This component and the accompanying materials are made available williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members williamr@2: * which accompanies this distribution, and is available williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: * williamr@2: * Initial Contributors: williamr@2: * Nokia Corporation - initial contribution. williamr@2: * williamr@2: * Contributors: williamr@2: * williamr@2: * Description: williamr@2: * Name : sipnotifydialogassoc.h williamr@2: * Part of : SIP Client williamr@2: * Interface : SDK API, SIP Client API williamr@2: * Version : 1.0 williamr@2: * williamr@2: */ williamr@2: williamr@2: williamr@2: williamr@2: williamr@2: #ifndef CSIPNOTIFYDIALOGASSOC_H williamr@2: #define CSIPNOTIFYDIALOGASSOC_H williamr@2: williamr@2: // INCLUDES williamr@2: #include williamr@2: #include "sipdialogassocbase.h" williamr@2: williamr@2: // CONSTANTS williamr@2: williamr@2: // FORWARD DECLARATIONS williamr@2: class CSIPEventHeader; williamr@2: class CSIPSubscriptionStateHeader; williamr@2: class MSIPRegistrationContext; williamr@2: williamr@2: // CLASS DECLARATION williamr@2: williamr@2: /** williamr@2: * @publishedAll williamr@2: * @released williamr@2: * williamr@2: * Class for managing SIP NOTIFY dialog associations. williamr@2: * It provides services for creating, using and williamr@2: * terminating SIP NOTIFY dialog associations. The user can have multiple williamr@2: * NOTIFY dialog associations per same SIP dialog. williamr@2: * Implementation handles SUBSCRIBE on the dialog level defined by Call-Id, williamr@2: * local and remote tags; user is responsible for "Event" and williamr@2: * "Subscription-State" header semantics. williamr@2: * @lib sipclient.lib williamr@2: */ williamr@2: class CSIPNotifyDialogAssoc: public CSIPDialogAssocBase williamr@2: { williamr@2: public: // Constructors and destructor williamr@2: williamr@2: /** williamr@2: * Two-phased constructor. williamr@2: * The response to the received SIP request will create a SIP NOTIFY williamr@2: * dialog association that will be correlated with the SIP dialog in williamr@2: * which SIP server transaction was received. If the server transaction williamr@2: * was not received within a SIP dialog, a new SIP dialog is created. williamr@2: * The server transaction must be either SUBSCRIBE or REFER transaction. williamr@2: * @pre aTransaction.State()==ETrying || EProceeding williamr@2: * @pre aTransaction.Type() == williamr@2: * SipStrConsts::ESubscribe || SipStrConsts::ERefer williamr@2: * @pre aEvent != 0 && aState != 0 williamr@2: * @param aTransaction a SIP server transaction williamr@2: * @param aEvent an event to send a notification about; the ownership williamr@2: * is transferred. williamr@2: * @param aState a subscription state; the ownership is transferred. williamr@2: * @return New object; the ownership is transferred williamr@2: * @leave KErrArgument if aTransaction is not a SUBSCRIBE or REFER williamr@2: * transaction, or aEvent == 0 or aState == 0. williamr@2: * @leave KErrSIPInvalidTransactionState if aTransaction is in a wrong williamr@2: * state williamr@2: */ williamr@2: IMPORT_C static CSIPNotifyDialogAssoc* williamr@2: NewL(CSIPServerTransaction& aTransaction, williamr@2: CSIPEventHeader* aEvent, williamr@2: CSIPSubscriptionStateHeader* aState); williamr@2: williamr@2: /** williamr@2: * Two-phased constructor. williamr@2: * The response to the received SIP request will create a SIP NOTIFY williamr@2: * dialog association that will be correlated with the SIP dialog in williamr@2: * which SIP server transaction was received. If the server transaction williamr@2: * was not received within a SIP dialog, a new SIP dialog is created. williamr@2: * The server transaction must be either SUBSCRIBE or REFER transaction. williamr@2: * @pre aTransaction.State()==ETrying || EProceeding williamr@2: * @pre aTransaction.Type() == williamr@2: * SipStrConsts::ESubscribe || SipStrConsts::ERefer williamr@2: * @pre aEvent != 0 && aState != 0 williamr@2: * @param aTransaction a SIP server transaction williamr@2: * @param aEvent an event to send a notification about; the ownership williamr@2: * is transferred. williamr@2: * @param aState a subscription state; the ownership is transferred. williamr@2: * @return New object; the ownership is transferred williamr@2: * @leave KErrArgument if aTransaction is not a SUBSCRIBE or REFER williamr@2: * transaction, or aEvent == 0 or aState == 0. williamr@2: * @leave KErrSIPInvalidTransactionState if aTransaction is in a wrong williamr@2: * state williamr@2: */ williamr@2: IMPORT_C static CSIPNotifyDialogAssoc* williamr@2: NewLC(CSIPServerTransaction& aTransaction, williamr@2: CSIPEventHeader* aEvent, williamr@2: CSIPSubscriptionStateHeader* aState); williamr@2: williamr@2: /** williamr@2: * Two-phased constructor. williamr@2: * The response to the received SIP request will create a SIP NOTIFY williamr@2: * dialog association that will be correlated with the SIP dialog in williamr@2: * which SIP server transaction was received. If the server transaction williamr@2: * was not received within a SIP dialog, a new SIP dialog is created. williamr@2: * The server transaction must be either SUBSCRIBE or REFER transaction. williamr@2: * @pre aTransaction.State()==ETrying || EProceeding williamr@2: * @pre aTransaction.Type() == williamr@2: * SipStrConsts::ESubscribe || SipStrConsts::ERefer williamr@2: * @pre aContext.IsContextActive() == ETrue williamr@2: * @pre aEvent != 0 && aState != 0 williamr@2: * @param aTransaction a SIP server transaction williamr@2: * @param aContext that will be used for populating williamr@2: * the Contact-header of the response to aTransaction williamr@2: * @param aEvent an event to send a notification about; the ownership williamr@2: * is transferred. williamr@2: * @param aState a subscription state; the ownership is transferred. williamr@2: * @return New object; the ownership is transferred williamr@2: * @leave KErrArgument if aTransaction is not a SUBSCRIBE or REFER williamr@2: * transaction, or aEvent == 0 or aState == 0. williamr@2: * @leave KErrSIPInvalidTransactionState if aTransaction is in a wrong williamr@2: * state williamr@2: */ williamr@2: IMPORT_C static CSIPNotifyDialogAssoc* williamr@2: NewL(CSIPServerTransaction& aTransaction, williamr@2: const MSIPRegistrationContext& aContext, williamr@2: CSIPEventHeader* aEvent, williamr@2: CSIPSubscriptionStateHeader* aState); williamr@2: williamr@2: /** williamr@2: * Two-phased constructor. williamr@2: * The response to the received SIP request will create a SIP NOTIFY williamr@2: * dialog association that will be correlated with the SIP dialog in williamr@2: * which SIP server transaction was received. If the server transaction williamr@2: * was not received within a SIP dialog, a new SIP dialog is created. williamr@2: * The server transaction must be either SUBSCRIBE or REFER transaction. williamr@2: * @pre aTransaction.State()==ETrying || EProceeding williamr@2: * @pre aTransaction.Type() == williamr@2: * SipStrConsts::ESubscribe || SipStrConsts::ERefer williamr@2: * @pre aContext.IsContextActive() == ETrue williamr@2: * @pre aEvent != 0 && aState != 0 williamr@2: * @param aTransaction a SIP server transaction williamr@2: * @param aContext that will be used for populating williamr@2: * the Contact-header of the response to aTransaction williamr@2: * @param aEvent an event to send a notification about; the ownership williamr@2: * is transferred. williamr@2: * @param aState a subscription state; the ownership is transferred. williamr@2: * @return New object; the ownership is transferred williamr@2: * @leave KErrArgument if aTransaction is not a SUBSCRIBE or REFER williamr@2: * transaction, or aEvent == 0 or aState == 0. williamr@2: * @leave KErrSIPInvalidTransactionState if aTransaction is in a wrong williamr@2: * state williamr@2: */ williamr@2: IMPORT_C static CSIPNotifyDialogAssoc* williamr@2: NewLC(CSIPServerTransaction& aTransaction, williamr@2: const MSIPRegistrationContext& aContext, williamr@2: CSIPEventHeader* aEvent, williamr@2: CSIPSubscriptionStateHeader* aState); williamr@2: williamr@2: /** williamr@2: * Destructor williamr@2: */ williamr@2: IMPORT_C ~CSIPNotifyDialogAssoc(); williamr@2: williamr@2: public: // New functions williamr@2: williamr@2: /** williamr@2: * Creates NOTIFY and sends it to the remote target. williamr@2: * If client provides optional SIP headers they must williamr@2: * not contain Event and Subscription-State headers. williamr@2: * @pre Dialog().Connection().State()==EActive williamr@2: * @pre Dialog().State()==CSIPDialog::TState::EConfirmed williamr@2: * @param aElements optional SIP message headers and body. williamr@2: * Ownership is transferred. williamr@2: * @return NOTIFY SIP UAC transaction williamr@2: * @leave KErrSIPInvalidDialogState if dialog's state is incorrect williamr@2: * @leave KErrSIPResourceNotAvailable if a required SIP Client API williamr@2: * object has been deleted. williamr@2: * @capability NetworkServices williamr@2: */ williamr@2: IMPORT_C CSIPClientTransaction* williamr@2: SendNotifyL(CSIPMessageElements* aElements=0); williamr@2: williamr@2: /** williamr@2: * Gets an event about which the notification is done williamr@2: * @return an event williamr@2: */ williamr@2: IMPORT_C const CSIPEventHeader& Event() const; williamr@2: williamr@2: /** williamr@2: * Gets subscription state williamr@2: * @return subscription state williamr@2: */ williamr@2: IMPORT_C CSIPSubscriptionStateHeader& SubscriptionState(); williamr@2: williamr@2: /** williamr@2: * Gets subscription state williamr@2: * @return subscription state williamr@2: */ williamr@2: IMPORT_C const CSIPSubscriptionStateHeader& SubscriptionState() const; williamr@2: williamr@2: public: // New functions, for internal use williamr@2: williamr@2: CSIPClientTransaction* williamr@2: DoSendNotifyWithinDialogL(CSIPMessageElements* aElements); williamr@2: williamr@2: private: // Constructors williamr@2: williamr@2: CSIPNotifyDialogAssoc(); williamr@2: williamr@2: void ConstructL(CSIPServerTransaction& aTransaction, williamr@2: const MSIPRegistrationContext* aContext, williamr@2: CSIPEventHeader* aEvent, williamr@2: CSIPSubscriptionStateHeader* aState); williamr@2: williamr@2: private: // Data williamr@2: williamr@2: CSIPEventHeader* iEvent; williamr@2: CSIPSubscriptionStateHeader* iSubscriptionState; williamr@2: }; williamr@2: williamr@2: #endif