/*
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
* Name        : sipdialogassocbase.h
* Part of     : SIP Client
* Interface   : SDK API, SIP Client API
* Version     : 1.0
*
*/



#ifndef CSIPDIALOGASSOCBASE_H
#define CSIPDIALOGASSOCBASE_H

// INCLUDES
#include <stringpool.h>

// FORWARD DECLARATIONS
class CSIPMessageElements;
class CSIPClientTransaction;
class CSIPDialog;
class CSIPRefresh;
class CSIPServerTransaction;
class CSIPDialogAssocImplementation;

// CLASS DECLARATION

/**
*  @publishedAll
*  @released
*
*  Base class for SIP dialog associations. It provides services for getting
*  associated SIP dialog, actual dialog association type and for sending non
*  target refresh requests within the dialog association.
*  @lib sipclient
*/
class CSIPDialogAssocBase : public CBase
	{
	public: // Destructor

		/**
		* Destructor
        * @internalComponent		
		*/
		virtual ~CSIPDialogAssocBase();    

	public: // New functions

		/**
		* Gets the dialog this dialog association belongs to
		* @return associated dialog
		*/
		IMPORT_C const CSIPDialog& Dialog() const;

		/**
		* Gets dialog this dialog association belongs to
		* @return associated dialog
		*/
		IMPORT_C CSIPDialog& Dialog();

		/**
		* Creates SIP request and sends it to the remote target.
		* This function should be used for sending SIP extension
		* requests within dialog assocation that do not cause 
		* sip dialog associations to be created. In SIP terms
		* this request is non target refresh request.
		* @pre SIPDialog().State() != CSIPDialog::EInit &&
		*      SIPDialog().State() != CSIPDialog::ETerminated
        * @pre Dialog().Connection().State() == EActive
		* @pre aMethod != "REGISTER" |"INVITE" | "BYE" | "CANCEL" | "ACK" |
        *   "SUBSCRIBE" | "NOTIFY" | "UPDATE" | "PRACK" | "REFER"
		* @param aElements contains optional SIP message headers and body.
        *   Ownership is transferred.
		* @return SIP extension client transaction. Ownership is transferred.
		* @leave KErrSIPInvalidDialogState If dialog's state is not correct
		* @leave KErrArgument if invalid value has been set to aMethod		
		* @leave KErrSIPResourceNotAvailable if a required SIP Client API
		*	object has been deleted
		* @capability NetworkServices
		*/
		IMPORT_C virtual CSIPClientTransaction*
            SendNonTargetRefreshRequestL(RStringF aMethod,
                                         CSIPMessageElements* aElements);

        /**
        * Gets dialog association type.
        *
        * @return dialog association type e.g. "INVITE", "SUBSCRIBE" etc...
        */
        IMPORT_C RStringF Type() const;

		/**
        * Tests if the request is a non target refresh request
        * @param aMethod a method to test
        * @return ETrue if is non target refresh request; EFalse otherwise
        */        
        IMPORT_C TBool IsNonTargetRefreshRequest(RStringF aMethod) const;

	public: // New functions, for internal use

		/**
		* Returns the implementation instance.
 		* @return CSIPDialogAssocImplementation
		*/
		CSIPDialogAssocImplementation& Implementation();

		/**
        * Searches for a refresh with the matching id. Default implementation
        * returns NULL. Those classes derived from CSIPDialogAssocBase, which
        * can contain refreshes must implement this function for searching the
        * correct refresh.
        *
        * @return CSIPRefresh if found, NULL otherwise. 
        *         The ownership is not transferred.
        * @internalComponent
        */
        virtual CSIPRefresh* FindRefresh(TUint32 aRefreshId);

        /**
        * @internalComponent
        */
		virtual void DeletingRefresh(CSIPRefresh& aRefresh, TUint32 aRefreshId);
		
	protected: // Constructors, for internal use

        /*
		* Constructor
		*/
        CSIPDialogAssocBase();

        void ConstructL(RStringF aType, CSIPDialog& aDialog);
        void ConstructL(RStringF aType,
        				CSIPDialog& aDialog,
        				CSIPServerTransaction& aTransaction);

    protected: // Data

        /**
        * Implementation instance, CSIPDialogAssocBase owns it
        * @internalComponent
        */
		CSIPDialogAssocImplementation* iImplementation;

	private: // For testing purposes
#ifdef CPPUNIT_TEST
        friend class CSIPInviteDialogAssoc_Test;
#endif
		void __DbgTestInvariant() const;

	};

#endif