/*

* Copyright (c) 2005 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:   

*

*/

#ifndef MCEACTIONSET_H

#define MCEACTIONSET_H

#include <e32std.h>

#include "mcesrv.h"

#include "mcesession.h"

#include "mcestate.h"

#include "mcesipsession.h"

#include "mcedefs.h"

// FORWARD DECLARATION

class CMceSipSession;

class CSIPServerTransaction;

class CSIPClientTransaction;

class CMceMsgBase;

class CMceMediaManager;

class CSIPHeaderBase;

class CSdpDocument;

class CSIPMessageElements;

class CMceComSession;

class CSIPResponseElements;

class CMceMsgSIPReply;

class CMceMsgSIPData;

class TMceMccComEvent;

class TMceStateTransitionEvent;

const TInt KMceAutoReasonPhrase = KErrNotFound;

// CLASS DECLARATION

/**

*  MCE SIP session.

*

*  @lib 

*  @since

*/

class TMceActionSet 

	{

public: // Constructors and destructor

	/**

	* C++ constructor

	* @param aSession, reference to session.

	*/

	TMceActionSet( CMceSipSession& aSession );

public://state changing related

	/**

	* Changes server state

	* @param aNewState new server state

	*/

    void StateChanged( TMceStateIndex aNewState );

	/**

	* Changes client state synchronously as a response 

	* to client's ITC call

	* @param aIds set of ids defining ITC call context

	* @param aNewState new client state

	* @param aStatus status

	*/

    void ClientStateChanged( TMceIds& aIds, 

                             CMceSession::TState aNewState,

                             TInt aStatus = KErrNone );

	/**

	* Changes client state. 

	* This is called when there is no SIP data for client

	* explaining the reason of state change. This happens,

	* for example, when client is establishing session and

	* there is no response, but media manager fails in offer

	* creation.

	* @param aNewState new client state

	* @param aReason a reason of state change

	*/

    void ClientStateChangedL( CMceSession::TState aNewState, 

                              TInt aReason = KErrNone );

	/**

	* Changes client state. 

	* This is called when there is SIP response explaining

	* the reason of state change. If handling of response fails

	* (error) reason is used for identifying the problem.

	* @param aNewState new client state

	* @param aResponse SIP response

	* @param aReason a reason of state change

	*/

    void ClientStateChangedL( CMceSession::TState aNewState, 

                              CSIPClientTransaction& aResponse,

                              TInt aReason = KErrNone );

	/**

	* Changes client state. 

	* This is called when there is SIP request explaining

	* the reason of state change. Only BYE is supported.

	* This method should not be used when handling INVITE request,

	* becauseINVITE causes always new incoming session creation and thus

	* state change is always EIncoming. 

	* @param aNewState new client state

	* @param aRequest SIP request

	* @param aReason a reason of state change

	*/

    void ClientStateChangedL( CMceSession::TState aNewState, 

                              CSIPServerTransaction& aRequest );

	/**

	* Changes client state. Used in session update.

	* This is called when there is SIP response explaining

	* the reason of state change and client session (body) must be 

	* updated because of it. If handling of response has been 

	* failed (error) reason is used for identifying the problem.

	* If reason is other than KErrNone, EMceItcUpdateFailed is 

	* used in callback.

	* @param aNewState new client state

	* @param aBody client session

	* @param aResponse SIP response

	* @param aReason a reason of state change

	*/

    void ClientStateChangedL( CMceSession::TState aNewState, 

                              CMceComSession& aBody,

                              CSIPClientTransaction& aResponse,

                              TInt aReason = KErrNone );

	/**

	* Changes client state. Used in session update.

	* This is called when client session (body) must be 

	* updated. This happens, for example, when client is updating

	* session, but media manager fails in update creation and 

	* rollback is needed.

	* EMceItcUpdateFailed call back is used always

	* used in callback.

	* @param aNewState new client state

	* @param aBody client session

	* @param aReason a reason of state change

	*/

    void ClientStateChangedL( CMceSession::TState aNewState, 

                              CMceComSession& aBody, 

                              TInt aReason );

	/**

	* informs client of occured severe error

	* @param aError a reason of error

	*/

    void ClientErrorOccured( TInt aError );

public://basic session establisment and update

    /**

    * Encode body to SDP. Encoded body can me obtained with 

    * Offer() method.

    */

    void EncodeL();

    /**

    * Decode body from SDP, which is created with

    * method CreateSDP() and stored as session offer.

    * @return warning code

    */

    TMceSipWarningCode DecodeL();

    /**

    * Decode body from SDP, which is created with

    * method CreateSDP() and stored as session offer.

    * @return warning code

    */

    TMceSipWarningCode Decode();

    /**

    * Update media manager according to body

    * @return return status:

    *       -System error < 0: error situation

    *       -KMceReady: update was synchronous

    *       -KMceAsync: updating asynchronously, wait EMEMediaUpdated event. 

    */

    TMceReturnStatus UpdateL();

    /**

    * Update media manager according to body

    * @return return status:

    *       -System error < 0: error situation

    *       -KMceReady: update was synchronous

    *       -KMceAsync: updating asynchronously, wait EMEMediaUpdated event. 

    */

    TMceReturnStatus Update();

    /**

    * Reserve resources

    * @return return status:

    *       -System error < 0: error situation

    *       -KMceReady: reservation was synchronous or not needed

    *       -KMceAsync: reserving asynchronously, wait EMEMediaReserved event. 

    */                  

    TMceReturnStatus ReserveL();

    /**

    * Update clients parameters in body

    * @param aIds set of ids defining ITC call context

    * @param aBody client session

    */

    void UpdateBodyL( TMceIds& aIds, CMceMsgBase& aBody );

    /**

    * Create body candidate for session update.

    * @param aType the direction of the body candidate

    */

    void CreateBodyCandidateL( CMceComSession::TType aType );

    /**

    * Returns truth value, reservation needed.

    * @return ETrue, if reservation is needed

    */

    TBool ReservationNeeded();

    /**

	* Sends INVITE with SDP

	*/

    void SendInviteL();

	/**

	* Informs client about new incoming session

	* @param aInvite server transaction

	*/

    void ClientUpdateIncomingSessionL( CSIPServerTransaction& aInvite );

	/**

	* Informs client about new incoming session update

	* @param aInvite server transaction

	* @param aCallback callback for client

	*/

    void ClientUpdateSessionL( CSIPServerTransaction& aInvite, 

                               TUint32 aCallback = EMceItcIncomingUpdate );

public://requests

	/**

	* Sends INVITE

	* @param aData session body for creation of SDP content

	*/

    void SendInviteL( CMceComSession& aData );

	/**

	* Sends ACK to response (2XX)

	* @param aResponse client transaction

	*/

	void SendACKL( CSIPClientTransaction& aResponse );

	/**

	* Sends BYE with default headers

	*/

    void SendBYEL();

	/**

	* Sends BYE with client defined headers and content

	* This is called when client terminates (EMceItcTerminateSession)

	* @param aData data containing headers

	*/

    void SendBYEL( CMceMsgBase& aData );

	/**

	* Sends CANCEL

    * @return ETrue, if CANCEL was sent

	*/

    TBool SendCancelL();

    /**

	* Sends UPDATE

    * @return ETrue, if UPDATE was sent

	*/

    void SendUpdateRequestL();

    /**

	* Sends PRACK

	* @param aContent if ETrue, use content in PRACK

    * @return ETrue, if PRACK was sent

	*/

    void SendPrackL( TBool aContent = ETrue );

	/**

	* Sends Extension Request 

	* @param  aData SIP data 

	* @param aIds set of ids defining ITC call context

   	*/

    void SendExtensionRequestL( CMceMsgBase& aData, TMceIds& aIds );

    /**

	* Receive Response to the Extension Requests sent.

	* @param aEvent, event

	*/

    void ReceiveExtensionRequestL( TMceStateTransitionEvent& aEvent );

    /**

	* Receive Error for an Extension Request sent. 

	* Error Can be anything like ICMP, SIP Timeout.

	* @param aRequest, request for which error is received.

	*/

    void ReceiveExtensionError( CSIPTransactionBase& aTransaction, TInt aError );

public://responses

	/**

	* Sends answer to offer carried by INVITE

	* This is called when client accepts (EMceItcAcceptSession)

	* @param aRequest server transaction

	* @param aReply user defined response (CMceMsgSIPReply)

	*/

    void SendAnswerL( CSIPServerTransaction& aRequest, 

                      CMceMsgBase& aReply );

	/**

	* Sends answer to offer carried by re-INVITE

	* @param aRequest the re-invite

	*/

    void SendAnswerL( CSIPServerTransaction& aRequest );

	/**

	* Sends rejection 488 Not Acceptable Here to offer with warning,

	* if warning is assigned to one of 3xx warnings. If warning is assigned

	* to 4xx, 5xx or 6xx it is been interpretet as response code.

	* @param aReason reason why 488 or response code is sent

	* @param aInvite server transaction

	*/

    void SendRejectOfferWithWarningL( TMceSipWarningCode aReason, 

                                      CSIPServerTransaction& aInvite );

	/**

	* Sends 200OK reponse (to BYE)

	* @param aRequest server transaction

	*/

    void Send200OKL( CSIPServerTransaction& aRequest );

	/**

	* Sends 603 Decline or user response to request (INVITE)

	* @param aRequest server transaction

	* @param aReply user defined response (CMceMsgSIPReply)

	*/

    void SendDeclineL( CSIPServerTransaction& aRequest, 

                       CMceMsgBase& aReply );

	/**

	* Sends 180 Ringing to request (INVITE)

	* @param aRequest server transaction

	* @param aReply user defined response (CMceMsgSIPReply)

	* @return ETrue, if response was sent reliably

	*/

    TBool SendRingL( CSIPServerTransaction& aRequest,

                    CMceMsgBase& aReply );

    /**

	* Sends 182 SipQueued message to request (INVITE)

	* @param aRequest server transaction

	* @param aReply user defined response (CMceMsgSIPReply)

	* @return ETrue, if response was sent reliably

	*/

    TBool SendSipQueuedL( CSIPServerTransaction& aRequest,

                          CMceMsgBase& aReply );

    /**

	* Sends a response to request (INVITE). 

	* For responses sent automatically by state machine, 

	* not for those coming from client.

	* @param aRequest server transaction

	* @param aCode the reason code

	* @param aReason the reasn phrase as string pool index

	*/

    void SendResponseL( CSIPServerTransaction& aRequest,

                        TUint32 aCode,

                        TInt aReason );

    /**

    * Seize re-sending UPDATE/PRACK. 

    * @return ETrue if interrupt succeeded.

    */                           

    TBool InterruptConfirming();

   /**

	* Receive Responses to the Extnesion request sent.

	* @param aResponse, response need to be sent to the client

	* @param aBody session body

	*/

    void ReceiveExtensionResponseL( CSIPClientTransaction& aResponse, 

    						CMceComSession& aBody );

	/**

	* Sends a response to the extension requests received

	* @param  aData SIP data 

	* @param aIds set of ids defining ITC call context

	*/

    void SendExtensionResponseL( CMceMsgBase& aData, TMceIds& aIds );

public://new functions

	/**

	* Called when update has been succeed

	*/

    void UpdateSucceed();

	/**

	* Called when update has been failed

	*/

    void UpdateFailed();

	/**

	* Encodes session body

	* @return aEncodedBody place holder to encode session body

	*/

    HBufC8* BodyToTextL();

	/**

	* Creates SDP document based on client/server transaction

	* @param aSDPContainer transaction 

	* containing SDP document in its content

	* @return system wide error / SDP error

	*/

    TInt CreateSDP( CSIPTransactionBase& aSDPContainer );

   /**

    * Process the ReliableResponse 

    * @return EFalse if response contains RSeq value that is not one higher than the last one.

    */

    TBool ProcessReliableResponse( const CSIPResponseElements& aResponseElements );

    /**

    * Handle Reliable Response 

    * @return EFalse if response contains RSeq value that is not one higher than the last one.

    */

    /**

    * Check if session response contact header has sips uri or tls parameters

    * @param aTransaction sip transaction msgs

    * @return void

    */

    void CheckContactIsSecureL( CSIPTransactionBase& aTransaction );

   /**

    * Finds if the Request is Extenssion Request

    * @return ETrue if the Request is Extension Request

    */

    TBool IsExtensionRequest( RStringF method );

public://Session timer related

	/**

	* Process session timer data in received INVITE

	* @param aRequest the request

	*/

	void ProcessSessionTimerServerL( CSIPServerTransaction& aRequest );

	/**

	* Process session timer data in received response

	* @param aResponse the response

	*/

	void ProcessSessionTimerClientL( CSIPClientTransaction& aResponse );

	/**

	* Resets session timer

	*/

    void ResetSessionTimerL();

    /**

	* Stop pending timer

	*/

    void StopPendingTimer();

	/**

	* Sends re-invite indicating session refresh

	*/

    void SendSessionRefreshL();

public://Media related

	/**

	* Handles ITC function, which controls media

	* @param aIds set of ids defining ITC call context

	* @param aAction ITC function defining the action

	* @return aReturnMessage message to return

	*/

    HBufC8* ControlMediaL( TMceIds& aIds, TMceItcFunctions aAction );

	/**

	* Handles ITC function, which controls media

	* @param aIds set of ids defining ITC call context

	* @param aAction ITC function defining the action

	* @param aMessage message

	*/

    void ControlMediaL( TMceIds& aIds, TMceItcFunctions aAction,