Msrp/MsrpClient/inc/CMSRP.h
branchMSRP_FrameWork
changeset 25 505ad3f0ce5c
child 58 cdb720e67852
equal deleted inserted replaced
22:f1578314b8da 25:505ad3f0ce5c
       
     1 /*
       
     2 * Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html."
       
     8 * Initial Contributors:
       
     9 * Nokia Corporation - initial contribution.
       
    10 * Contributors:
       
    11 *
       
    12 * Description:
       
    13 * MSRP Implementation
       
    14 *
       
    15 */
       
    16 
       
    17 // This file defines the API for MSRPClient.dll
       
    18 
       
    19 #ifndef CMSRP_H_
       
    20 #define CMSRP_H_
       
    21 
       
    22 // @platform
       
    23 
       
    24 //  Include Files
       
    25 
       
    26 #include <e32base.h>
       
    27 #include <e32std.h>
       
    28 
       
    29 
       
    30 // Forward Declarations
       
    31 class CMSRPSession;
       
    32 class CMSRPImplementation;
       
    33 class MMSRPSessionObserver;
       
    34 
       
    35 
       
    36 // Class declaration.
       
    37 class CMSRP : public CBase
       
    38     {
       
    39 public:
       
    40     
       
    41     /** 
       
    42      * Object Creation
       
    43      * @param aUid the UID of the application that is set by the client
       
    44      */
       
    45     IMPORT_C static CMSRP* NewL( const TUid& aUid );
       
    46     
       
    47     /**
       
    48      * Object Creation
       
    49      * @param aUid the UID of the application that is set by the client
       
    50      */
       
    51     IMPORT_C static CMSRP* NewLC( const TUid& aUid );
       
    52     
       
    53     IMPORT_C ~CMSRP();
       
    54 
       
    55     /**
       
    56      * Creates an msrp session for the client
       
    57      * @param aObserver a reference to the session observer created by the client.
       
    58      * This client-side observer receives callbacks from the msrp stack, in order to
       
    59      * notify it of varous events
       
    60      * @param aIapId the IAP on which the connection has to start for this session
       
    61      * @return the created session object which can be used by the client
       
    62      */
       
    63     IMPORT_C CMSRPSession* CreateMSRPSessionL( MMSRPSessionObserver& aObserver, 
       
    64                                                const TUint aIapId );
       
    65     
       
    66     /** 
       
    67      * Closes the msrp session that the client had created.
       
    68      * All the resources associated with the session are freed
       
    69      * @param aMsrpSession the session that needs to be closed
       
    70      */
       
    71     IMPORT_C void CloseMSRPSession( CMSRPSession* aMsrpSession );
       
    72 
       
    73 private:
       
    74     
       
    75     void ConstructL( const TUid& aUid );
       
    76     
       
    77 private:
       
    78         
       
    79     CMSRPImplementation* iMSRPImpl;
       
    80     
       
    81     };
       
    82 
       
    83 #endif  // CMSRP_H_
       
    84