Msrp/MsrpClient/inc/CMSRP.h
author shivsood
Sat, 12 Jun 2010 14:30:11 +0530
branchMSRP_FrameWork
changeset 25 505ad3f0ce5c
child 58 cdb720e67852
permissions -rw-r--r--
MSRP Chat and File Sharing FrameWork - Initial Contribution from Nokia. MSRP Implementation as per RFC 4975 and RCS specifications that supports 1. Multiple one to one chat data sessions as per RCS/RFC 4975 specifications. 2. Multiple file Sharing sessions as per RCS. 3. Data Chunking requirements as per 4975. 3. MSRP Connection sharing requirements as per RFC 4975

/*
* Copyright (c) 2009-2010 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:
* MSRP Implementation
*
*/

// This file defines the API for MSRPClient.dll

#ifndef CMSRP_H_
#define CMSRP_H_

// @platform

//  Include Files

#include <e32base.h>
#include <e32std.h>


// Forward Declarations
class CMSRPSession;
class CMSRPImplementation;
class MMSRPSessionObserver;


// Class declaration.
class CMSRP : public CBase
    {
public:
    
    /** 
     * Object Creation
     * @param aUid the UID of the application that is set by the client
     */
    IMPORT_C static CMSRP* NewL( const TUid& aUid );
    
    /**
     * Object Creation
     * @param aUid the UID of the application that is set by the client
     */
    IMPORT_C static CMSRP* NewLC( const TUid& aUid );
    
    IMPORT_C ~CMSRP();

    /**
     * Creates an msrp session for the client
     * @param aObserver a reference to the session observer created by the client.
     * This client-side observer receives callbacks from the msrp stack, in order to
     * notify it of varous events
     * @param aIapId the IAP on which the connection has to start for this session
     * @return the created session object which can be used by the client
     */
    IMPORT_C CMSRPSession* CreateMSRPSessionL( MMSRPSessionObserver& aObserver, 
                                               const TUint aIapId );
    
    /** 
     * Closes the msrp session that the client had created.
     * All the resources associated with the session are freed
     * @param aMsrpSession the session that needs to be closed
     */
    IMPORT_C void CloseMSRPSession( CMSRPSession* aMsrpSession );

private:
    
    void ConstructL( const TUid& aUid );
    
private:
        
    CMSRPImplementation* iMSRPImpl;
    
    };

#endif  // CMSRP_H_