dvrengine/CommonRecordingEngineClient/inc/RCRServiceBase.h
branchRCL_3
changeset 47 826cea16efd9
parent 45 798ee5f1972c
child 48 13a33d82ad98
equal deleted inserted replaced
45:798ee5f1972c 47:826cea16efd9
     1 /*
       
     2 * Copyright (c) 2007 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 the License "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 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    Interface for CR Client's ServiceBase class.*
       
    15 */
       
    16 
       
    17 
       
    18 
       
    19 
       
    20 #ifndef RCRSERVICEBASE_H
       
    21 #define RCRSERVICEBASE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 #include <ipvideo/CRTypeDefs.h>
       
    26 
       
    27 // CONSTANTS
       
    28 // None
       
    29 
       
    30 // MACROS
       
    31 // None
       
    32 
       
    33 // DATA TYPES
       
    34 // None
       
    35 
       
    36 // FORWARD DECLARATIONS
       
    37 class RCRClient;
       
    38 
       
    39 // CLASS DECLARATION
       
    40 
       
    41 /**
       
    42 *  Base class for services. This represents a client-side sub-session 
       
    43 *  and has a corresponding sub-session object on the server-side.
       
    44 *
       
    45 *  @lib CommonRecordingEngine.lib
       
    46 *  @since Series 60 3.0
       
    47 */
       
    48 NONSHARABLE_CLASS( RCRServiceBase ) : public RSubSessionBase
       
    49     {
       
    50 
       
    51 public: // Constructors and destructors
       
    52 
       
    53     /**
       
    54     * C++ default constructor.
       
    55     */
       
    56     RCRServiceBase::RCRServiceBase( );
       
    57 
       
    58     /**
       
    59     * Open server.
       
    60     * @since Series 60 3.0
       
    61     * @param aClient a reference to the client.
       
    62     * @return KErrNone if successful, otherwise one of the system-wide error codes.
       
    63     */
       
    64     TInt Open( RCRClient& aClient );
       
    65 
       
    66     /**
       
    67     * Close server.
       
    68     * @since Series 60 3.0
       
    69     * @param none.
       
    70     * @return None
       
    71     */
       
    72     void Close();
       
    73 
       
    74     /**
       
    75     * Uses user panic to panic client.
       
    76     * @since Series 60 3.0
       
    77     * @param aFault Panic reason.
       
    78     * @return None.
       
    79     */
       
    80     void PanicClient( TInt aFault );
       
    81 
       
    82     /**
       
    83     * Getter for sessionhandle.
       
    84     * @since Series 60 3.0
       
    85     * @param none.
       
    86     * @return None.
       
    87     */
       
    88     inline RCRClient& SessionHandle() { return *iClient; }
       
    89 
       
    90 private: // Data
       
    91 
       
    92     /**
       
    93     * Pointer to client. Not owned.
       
    94     */
       
    95     RCRClient* iClient; 
       
    96 
       
    97     };
       
    98 
       
    99 #endif // RCRSERVICEBASE_H
       
   100 
       
   101 // End of File