Msrp/MsrpClient/inc/CMSRPSession.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
*
*/

#ifndef CMSRPSESSION_H_
#define CMSRPSESSION_H_

// System Includes
#include <e32base.h>

// Forward Declarations
class CMSRPSessionImplementation;
class MMSRPSessionObserver;
class RMSRP;
class CMSRPMessage;
class CMSRPSessionParams;


class CMSRPSession : public CBase
    {
    friend class CMSRPImplementation;
    
public:    
    
    /** 
     * Object Creation. This is not exported to the client. It is called
     * while attempting to create an msrp session.
     * @param aRMSRP an instance of the client server session
     * @param aObserver the session observer that is created by the client
     * @param aIapId IAP id of the application
     * @return session object
     */
    static CMSRPSession* NewL( RMSRP& aRMSRP,
                                        MMSRPSessionObserver& aObserver, 
                                        const TUint aIapId );
        
    /** 
     * Object Creation. This is not exported to the client. It is called
     * while attempting to create an msrp session.
     * @param aRMSRP an instance of the client server session
     * @param aObserver the session observer that is created by the client
     * @param aIapId IAP id of the application
     * @return session object
     */
    static CMSRPSession* NewLC( RMSRP& aRMSRP,
                                         MMSRPSessionObserver& aObserver,
                                         const TUint aIapId );
    
public:

    // === Post Creation; SDP negotiation parameter fetching.
                
    /**
     * Gives the local MSRP path that is used in the "a" line of SDP
     * @return local msrp path
     */    
    IMPORT_C TDesC8& LocalMSRPPath();

    /**
     * Sets the various parameters related to an MSRP session
     * @param aSessionParams the session settings object from which the 
     * settings need to be incorporated into the msrp session.
     * Eg. SR and FR report headers can be set using this
     */    
    IMPORT_C void SetSessionParams( CMSRPSessionParams& aSessionParams );
    
    
    // === Post SDP Negotiation; Connection Setup.
        
    /**
     * Connects to the remote node
     * @param aRemoteMsrpPath the msrp path of the remote node
     * This is obtained through the SDP negotiation
     * @return KErrNone or system wide error codes
     */
    IMPORT_C TInt Connect( const TDesC8& aRemoteMsrpPath );
    
    /**
     * Listens for connections from the remote node
     * @param aRemoteMsrpPath the msrp path of the remote node
     * This is obtained through the SDP negotiation
     * @return KErrNone or system wide error codes
     */
    IMPORT_C TInt Listen ( const TDesC8& aRemoteMsrpPath );
    
    
    // === Post Connection setup; Data Trasfer. 
   
    /**
     * Sends a message to the remote note that is connected
     * @param aMessage the data that needs to be sent
     * @param aMimeType the mime type of the data
     * @return the id of the message that was sent by the msrp stack
     */
    IMPORT_C HBufC8* SendBuffer( const TDesC8& aMessage, const TDesC8& aMimeType );
        
    /**
     * Cancels the send operation initiated by the client
     * @param aMessageId the id of the message that needs to be cancelled
     * @return KErrNone or system wide error codes
     */
    IMPORT_C TInt CancelSending( TDesC8& aMessageId );

    IMPORT_C TInt SendFile( const TFileName& aFileName, const TDesC8& aMimeType );
    
    IMPORT_C TInt CancelFileSending();
    
    IMPORT_C TInt ReceiveFile(const TFileName& aFileName,const TInt aFileSize, const TDesC8& aMimeType );

    IMPORT_C TInt CancelReceiveFile();
    
    IMPORT_C void NotifyProgress(TBool aFlag);
    

private:
    void ConstructL( RMSRP& aRMSRP,
                     MMSRPSessionObserver& aObserver,
                     const TUint aIapId );
    
    ~CMSRPSession();
        
private:
           
    CMSRPSessionImplementation* iMSRPSessionImpl;
    
    };

#endif /* CMSRPSESSION_H_ */