realtimenetprots/sipfw/ClientResolver/Resolver/inc/CSIPClientResolver.h
author Petteri Saari <petteri.saari@digia.com>
Thu, 25 Nov 2010 13:59:42 +0200
branchMSRP_FrameWork
changeset 58 cdb720e67852
parent 0 307788aac0a8
permissions -rw-r--r--
This release addresses the following issues: 1. The crash bug fix when receiving file 2. Now the sending is based on MSRP messages, there is no longer file receiving or sending. Client sends data as MSRP was designed. 3. Soma MSRP stack was created so that the client told the correct session-id, Symbian stack generated it by itself. This is not allowed, it was changed so that clients tell the session-id (same as used in SIP INVITE). 4. Unnecessary division of data to chunks removed when there is no need to interrupt sending. The message is sent in as few chunks as possible. 5. Stack can now receive files and chunks with ?unlimited? size. Old stack wrote the incoming data to memory and did not utilize disk space until the end of chunk was reached (large chunks from another client crashed it). 6. Now when writing the incoming data to file, it will take into account the byte-range header values. So, this complies with the RFC4975 requirements that stack must be able to handle chunks that come in any sequence. 7. Some buffering changes to outgoing/incoming data. 8. The outgoing data is now checked that it does not contain the created transaction-id before sending the data. 9. MSRP success reports are now implemented and tested against servers. 10. Progress report system fixed so progress is now visible on client (all the way to 100%). 11. Message Cancel receiving / Cancel sending now corrected and made to work as rfc4975 requires. (termination from sender and error code from receiver when cancelling). 12. Bug correction related to messages received not belonging to any session, old stack implementation did send error response, but after response was written it did give the buffer to client anyway. Now corrected.

/*
* 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          : CSIPClientResolver.h
* Part of       : SIP Client Resolver
* Version       : 1.0
*
*/




/**
 @internalComponent
*/

#ifndef CSIPCLIENTRESOLVER_H
#define CSIPCLIENTRESOLVER_H

#include <e32base.h>
#include <ecom/ecom.h>
#include "MSipClients.h"
#include "_sipcodecdefs.h"


// FORWARD DECLARATIONS
class CSIPClientData;
class CSIPClientDataParser;
class CSipLaunchingStrategies;
class TSipClient;
class CSIPRequest;
class CSIPResponse;
class CSIPClientResolver2;

// CLASS DEFINITIONS
/**
 *
 */
class CSIPClientResolver : public CActive, public MSipClients
    {
    public: // Constructors and destructor
	
        IMPORT_C static CSIPClientResolver* NewL ();
    
        IMPORT_C ~CSIPClientResolver ();

    public: // New functions

        IMPORT_C CSIPResponse* FindUidL(const CSIPRequest& aRequest,
								RArray< TSipClient >& aUids );
		
    public: // From MSipClients

        MSipClient* GetByUID( const TUid& aUid ) const;

    protected: // From CActive

        void DoCancel();
        void RunL();   

    private: // New methods

		/**
		* Refreshes clients' data for those clients
		* which are returning their SIP capabilities dynamically
		* instead of using fixed values in their plugin's resource file.
		*/
        void RefreshClientDataL();

		/// Fill implentation registry
		void ListImplementationsL();

		/// Delete implementation registry
		void RemoveRegistry();

		/// Start monitoring changes in ECom plugin implementations 
		void NotifyOnChange();

		/// Copies all the current implementations to the given array  
		void CopyAllUidsL( RArray< TUid >& aUids );

        /// Adds ROM- and RAM-based clients to the array
        void AddClientsL( RPointerArray< CSIPClientData >& aRegistry );

        /// Converts and appends ECom implementation information
        /// to and array of CSIPClientDatas
        void ConvertClientDataL( const RImplInfoPtrArray& aImplInfo,
                                 RPointerArray< CSIPClientData >& aRegistry,
                                 TBool aRomClient );

	    /// Adds CSIPClientData to the array based on ECom-plugin's data
		void AddClientDataL( RPointerArray< CSIPClientData >& aRegistry,
			                 CImplementationInformation& aInfo,
			                 TBool aRomClient );
		
		/// Creates a thread to load the client plugin and 
	    /// ask the capabilities from it and parses the results	                 
        void ReloadClientDataL( CSIPClientData& aClientData );

        /// Removes the implementations present in the first array 
        /// from the second array.
        void RemoveDuplicates( const RImplInfoPtrArray& aRomInfo,
                               RImplInfoPtrArray& aAllInfo );

		// Needed for cleanup of a RPointerArray< CSIPClientData >:
		static void ResetAndDestroy( TAny* anArray );
		
	    void CreateWorkerThreadL();
	
	    static TInt WorkerThreadFunction(TAny* aPtr);
	
	    void ReadPluginCapsL();		

    private:  // Constructors

        /// Default constructor
        CSIPClientResolver();
    
        /// 2nd phase constructor.
        void ConstructL();
    
    private: // private data

        /// Handle to ECom session. Owned.
        REComSession* iECom;

        /// XML parser for SIP client data
        CSIPClientDataParser* iClientDataParser;

        /// Information registry for installed SIP clients. Owned.
        RPointerArray< CSIPClientData >* iRegistry;

        /// Launching strategies. Owned.
        CSipLaunchingStrategies* iLaunchingStrategies;
        
        /// Used for parameter passing to worker thread
        TUid iTmpImplementationUid;
        
        /// Used for parameter passing to worker thread
        HBufC8* iTmpPluginCaps;

    private: // For testing purposes

         UNIT_TEST(CSIPClientResolver_test)
    };

#endif // CSIPCLIENTRESOLVER_H

// End of File