/*

* Copyright (c) 2006-2008 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:  Session base class for SVP MO and MT sessions. Contains methods 

*                common for SVP MO and MT sessions.

*

*/

#ifndef SVPSESSIONBASE_H

#define SVPSESSIONBASE_H

#include <e32base.h>

#include <mccpcall.h>

#include <mccpssobserver.h>

#include <mccpdtmfobserver.h> 

#include "svpsessionobserver.h"

#include "svpholdobserver.h"

#include "svptransferobserver.h"

#include "svptimer.h"

#include "svptimerobserver.h"

#include "svppropertywatchobserver.h"

#include "svpvolumeupdateobserver.h"

#include "svpdtmfeventobserver.h"

#include "svputdefs.h"

// FORWARD DECLARATIONS

class TMceTransactionDataContainer;

class CSVPUtility;

class CSVPRtpObserver;

class CSVPHoldController;

class MCCPCallObserver;

class MCCPSsObserver;

class CSVPTransferController;

class CMceInRefer;

class CSVPVolumeObserver;

class CSVPPropertyWatch;

class CSVPDTMFEventGenerator;

class CMceSession;

class CMceMediaStream;

class CMceMediaSink;

class CMceMediaSource;

class CMceEvent;

class CMceRefer;

class CDesC8Array;

/**

 *  SVP Session base

 *

 *  Base class for SVP MT and MO sessions.

 *

 *  @lib svp.dll

 *  @since S60 3.2

 */

class CSVPSessionBase : public CBase,

                        public MCCPCall,

                        public MSVPTransferObserver,

                        public MSVPHoldObserver,

                        public MSVPTimerObserver,

                        public MSVPPropertyWatchObserver,

                        public MSVPVolumeUpdateObserver,

                        public MSVPDTMFEventObserver

    {

public:

    /**

    * C++ default constructor.

    */

    CSVPSessionBase( TMceTransactionDataContainer& aContainer,

                     MSVPSessionObserver& aObserver, 

                     CSVPUtility& aSVPUtility,

                     CSVPRtpObserver& aRtpObserver );

    /**

    * Destructor.

    */

    virtual ~CSVPSessionBase();

public: // new functions    

    /**

     * Saves updated Mce session in cases where re-INVITE without

     * SDP is received

     * @Since S60 3.2

     * @param aUpdatedSession Session that is under update

     */

    void SetUpdatedSession( CMceInSession* aUpdatedSession );

    /**

    * Releases temporary secure session stored 

    * after secure session trial failed

    * @since Series 60 3.2

    */

    void ReleaseTempSecure();

    /**

    * Returns Mce session 

    * @Since S60 3.2

    * @param

    * @return instance of session

    */

    const CMceSession& Session() const;

    /**

    * Construcst audiostreams for MT and MO session

    * @since Series 60 3.2

    * @param None

    * @return 

    */   

    void ConstructAudioStreamsL();

    /**

    * Starts SVP timer

    * @since Series 60 3.2

    * @param aMilliSeconds

    * @param aTimerId

    * @return 

    */

    void StartTimerL( TInt aMilliSeconds, TInt aTimerId );

    /**

     * Stop specified SVP timer

     * @since Series 60 3.2

     * @param aTimerId The ID of the timer to stop.

     */

     void StopTimer( TInt aTimerId );

     /**

     * Stops started timers

     * @since Series 60 3.2

     * @return 

     */

     void StopTimers();

     /**

     * Returns correct timer value (RFC 3261 chapter 14.1)

     * @since Series 60 3.2

     * @return 

     */

     TInt ReinviteCrossoverTime();     

    /**

     * Sets observer for supplementary services events

     * @since Series 60 3.2

     * @return

     */ 

    void SetSsObserver( const MCCPSsObserver& aObserver );

    /**

     * Gets supplementary services events observer of session

     * @since Series 60 3.2

     * @return MCCPSsObserver supplementary services events observer

     */ 

    const MCCPSsObserver& GetSsObserver( );

    /**

    * Sets CCP DTMF observer to session

    * @since Series 60 3.2

    * @return 

    */

    void SetDtmfObserver( const MCCPDTMFObserver& aObserver );

    /**

    * Gets CCP DTMF observer 

    * @since Series 60 3.2

    * @return MCCPDTMFObserver CCP DTMF observer

    */

    const MCCPDTMFObserver& DtmfObserver();

    /**

    * Handles session state changes 

    * @since Series 60 3.2

    * @param aStatusCode Status code

    * @return 

    */

    void SessionStateChanged( TInt aStatusCode );

    /**

    * Handles session state changed announcement.

    * @since Series60 3.2

    * @param aSession MCE session

    * @return void

    */

    void HandleSessionStateChanged( CMceSession& aSession );

    /**

     * Handles the state change of a given stream.

     * @since S60 v3.2

     * @param aStream Stream whose state has changed.

     * @return void

     **/

    void HandleStreamStateChange( CMceMediaStream& aStream );

    /**

     * Handles the state change of a given stream & sink.

     * @since S60 v3.2

     * @param aStream Stream whose state has changed.

     * @param aSink Sink which is either Enabled or Disabled.

     * @return void

     **/

    void HandleStreamStateChange( CMceMediaStream& aStream,

            CMceMediaSink& aSink );

    /**

     * Handles the state change of a given stream & source

     * @since S60 v3.2

     * @param aStream Stream whose state has changed.

     * @param aSource Source which is either Enabled or Disabled.

     * @return void

     **/

    void HandleStreamStateChange( CMceMediaStream& aStream,

            CMceMediaSource& aSource );

    /**

    * Handles remote action after session is established.

    * @since Series60 3.2

    * @param None

    * @return

    */

    TInt IncomingRequest( CMceInSession& aUpdatedSession );

    /**

    * Returns Hold session 

    * @Since S60 3.2

    * @param None

    * @return Reference to the session hold controller

    */

    CSVPHoldController& HoldController() const;

    /**

    * Finds out if the session has hold controller

    * @since Series60 3.2

    * @param None

    * @return ETrue if session has hold controller, EFalse otherways

    */

    TBool HasHoldController() const;

    /**

     * Returns ETrue if session is muted

     * @since Series 60 3.2

     * @return TBool iMuted value

     */

    TBool IsSessionMuted() const;

    /**

    * Handles the event state changes.

    * @since Series 60 3.2

    * @param aEvent, the event that has changed.

    * @param aStatusCode, status code

	* @return KErrNone if succesfull, otherwise error code

    */

    TInt EventStateChanged( CMceEvent& aEvent,

				            TInt aStatusCode ); 

    /**

    * Handles the received notify.

    * @since Series 60 3.2

    * @param aEvent, the event that has changed.

    * @param aContainer, if present, holds details of received notify.

    */

    void NotifyReceived( CMceEvent& aEvent,

                            TMceTransactionDataContainer* aContainer );

    /**

    * Handles the refer state changes.

    * @since Series 60 3.2

    * @param aRefer, the refer that has changed.

    * @param aStatusCode, status code

    */

    void ReferStateChanged( CMceRefer& aRefer,

				            TInt aStatusCode ); 

    /**

    * Return the data container.

    * When session is the target session of the attended transfer.

    * @since Series 60 3.2

    * @return the mce data container

    */

    TMceTransactionDataContainer& MceTransactionDataContainer(); 

    /**

     * New incoming refer received.

     * @since Series 60 3.2

	 * @param aRefer, the new inbound refer. Ownership is

	 *	      transferred.

     * @param aReferTo SIP specific Refer-to header 

     * @param aContainer, if present, holds details of incoming refer.

     */

    void IncomingReferL( CMceInRefer* aRefer,

                        const TDesC8& aReferTo,

                        TMceTransactionDataContainer* aContainer );

    /**

     * Checks the MCE refer object.

     * @since S60 3.2

     * @param aRefer - refer to check

     * @return TBool true if same MCE refer object

     */

    TBool IsMceRefer( CMceRefer& aRefer ); 

    /**

     * Indicates whether call is secured or not

     * @since S60 3.2

     * @return TBool ETrue if call is secured

     */

    TBool SecureMandatory() const;

    /**

     * Is secure call prefered

     * @since S60 3.2

     * @return TBool ETrue is secure call is prefered

     */    

    TBool SecurePreferred() const;

    /**

     * Set secure mandatody flag true or false

     * @since S60 3.2

     * @param aSecMandatory flag value

     */   

    void SetSecureMandatory( TBool aSecMandatory );

    /**

     * Sets secure preferred flag true or false

     * @since S60 3.2

     * @param aSecPreferred flag value

     */    

    void SetSecurePreferred( TBool aSecPreferred );

    /**

     * Sets call event to be sent, used in secure and attended transfer cases.

     * @since S60 3.2

     * @param aCallEventToBeSent event value

     */   

    void SetCallEventToBeSent( MCCPCallObserver::TCCPCallEvent aCallEventToBeSent );

    /**

     * Checks if transfer is attended or unattended.

     * @since S60 3.2

     * @return TBool true if attended case

     */

    TBool IsAttended( ); 

    /**

    * The new recipient of the call can be fetched via this method.

    * @since S60 3.2

    * @param none

    * @return New recipient for the call after transfer

    */

    const TDesC& TransferTarget() const;

    /**

    * Set transfer data. Add Replaces and Referred-By headers.

    * Update transfer target url to sips: if secure status 1 or 2,

    * otherwise url updated to sip:

    * @since S60 3.2

    * @param aUserAgentHeaders On completion contains collected transfer headers.

    * @param aSecureStatus secure status

    */

    void SetTransferDataL( CDesC8Array* aUserAgentHeaders, TInt aSecureStatus );

    /**

    * Send notify incoming transfer case.

	* @param aStatusCode code coming from mce

    * @since Series60 3.2

    */

    void SendNotify( TInt aStatusCode );

    /**

    * Finds out if the session has incoming transfer ongoing

    * @since Series60 3.2

    * @return ETrue if incoming transfer ongoing, EFalse otherways

    */

    TBool IsIncomingTransfer();

	/**

	* Sets the FromHeader data

	* @since S60 3.2

	* @param aFromHeader reference to the FromHeader data to store

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

    TInt SetFromHeader( const TDesC8& aFromHeader );

	/**

    * Returns the FromHeader data. 

	* @since S60 3.2

	* @return pointer to FromHeader data

	*/

    TDesC8* FromHeader();

	/**

	* Sets the ToHeader data

	* @since S60 3.2

	* @param aToHeader reference to the ToHeader data to store

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

    TInt SetToHeader( const TDesC8& aToHeader );

	/**

    * Returns the ToHeader data. 

	* @since S60 3.2

	* @return pointer to ToHeader data

	*/

    TDesC8* ToHeader();

	/**

	* Sets the CallId data

	* @since S60 3.2

	* @param aCallId reference to the CallId data to store

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

    TInt SetCallId( const TDesC8& aCallId );

	/**

	* Returns the CallId data. 

	* @since S60 3.2

	* @return pointer to CallId data

	*/

    TDesC8* CallId();    

    /**

	* Sets the CSeq header data

	* @since S60 3.2

	* @param aCSeq reference to the CSeq header data to store

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

    TInt SetCSeqHeader( const TDesC8& aCSeq );

    /**

    * Returns the CSeqHeader data. 

	* @since S60 3.2

	* @return reference to CSeqHeader data

	*/

    const TDesC& CSeqHeader() const;    

    /**

    * Method for setting crypto context to secure session

    * @since S60 3.2

    */

    void SetCryptoContextL();

	/**

    * Gets CCP session observer 

    * @since Series 60 3.2

    * @return CCP session observer.

    */

    MCCPCallObserver& GetCCPSessionObserver( );

    /**

    * Handles update failure 

    * @since Series 60 3.2

    * @param aSession MCE session reference

    * @param aStatusCode Status code of the response received

    * @return None

    */

    void UpdateFailed( CMceSession& aSession, TInt aStatusCode );

    /**

     * Returns session keepalive timer value

     * @since Series 60 3.2

     * @return TInt returns keepalive timer value

     */

    TInt GetKeepAliveTime();

    /**

     * SVP received INVITE without SDP, this flag is set to

     * prevent extra incomingcall callback to CCE

     * @since Series 60 3.2

     * @return none

     */

    void SetEmptyReInvite();

    /**

     * Returns ETrue if empty re-INVITE was received by SVP

     * @since Series 60 3.2

     * @return TBool Flag value

     */

    TBool IsEmptyReInvite();

    /**

     * Returns ETrue if iSessionState is still in initial state.

     * @since Series 60 3.2

     * @return TBool Flag value

     */

    TBool IsIdle();

// dtmf

    /**

	* Cancels asynchronous DTMF string sending.

	* @since Series 60 3.2

	* @return KErrNone is successful, otherwiee antoher system wide error code

	*/

	TInt CancelDtmfStringSending();

	/**

	* Starts the transmission of a single DTMF tone across a

	* connected and active call.

	* @since S60 3.2

	* @param aTone Tone to be played.

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

	TInt StartDtmfTone( const TChar aTone );

	/**

	* Stops playing current DTMF tone.

	* @since S60 3.2

    * @param none

	* @return KErrNone if succesfull, otherwise another system wide error code

	*/

	TInt StopDtmfTone();

	/**

	* Plays DTMF string.