videoutils_plat/videoscheduler_api/inc/ipvideo/RCseSchedulerServiceBase.h
branchRCL_3
changeset 23 13a33d82ad98
parent 0 822a42b6c3f1
equal deleted inserted replaced
22:826cea16efd9 23:13a33d82ad98
       
     1 /*
       
     2 * Copyright (c) 2006 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 Cse Scheduler engine Client's ServiceBase class.*
       
    15 */
       
    16 
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __RCSESCHEDULERSERVICEBASE_H
       
    22 #define __RCSESCHEDULERSERVICEBASE_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include <e32base.h>
       
    26 
       
    27 // CONSTANTS
       
    28 // None.
       
    29 
       
    30 // MACROS
       
    31 // None.
       
    32 
       
    33 // DATA TYPES
       
    34 // None.
       
    35 
       
    36 // FUNCTION PROTOTYPES
       
    37 // None.
       
    38 
       
    39 // FORWARD DECLARATIONS
       
    40 class RCseSchedulerClient;
       
    41 
       
    42 // CLASS DECLARATION
       
    43 
       
    44 /**
       
    45 *  Base class for services. This represents a client-side sub-session 
       
    46 *  and has a corresponding sub-session object on the server-side.
       
    47 *
       
    48 *  @lib CseSchedulerClient.dll
       
    49 */
       
    50 class RCseSchedulerServiceBase : public RSubSessionBase
       
    51     {
       
    52     public:
       
    53         /**
       
    54         * C++ default constructor.
       
    55         */
       
    56         RCseSchedulerServiceBase();
       
    57 
       
    58         /**
       
    59         * Destructor.
       
    60         * @return None.
       
    61         */
       
    62         virtual ~RCseSchedulerServiceBase();
       
    63         
       
    64         /**
       
    65         * Open server.
       
    66         * @param aServer 
       
    67         * @return KErrNone if successful, otherwise one of the system-wide error codes.
       
    68         */
       
    69         TInt Open( RCseSchedulerClient& aClient );
       
    70 
       
    71         /**
       
    72         * Close server.
       
    73         * @return None
       
    74         */
       
    75         void Close();
       
    76 
       
    77         /**
       
    78         * Uses user panic to panic client.
       
    79         * @param aFault Panic reason.
       
    80         * @return None.
       
    81         */
       
    82         void PanicClient( TInt aFault ) const;
       
    83 
       
    84         /**
       
    85         * Sessionhandle
       
    86         */
       
    87         inline RCseSchedulerClient& SessionHandle() const { return *iClient; }
       
    88 
       
    89     private:
       
    90 
       
    91         /**
       
    92         * Pointer to client. Own.
       
    93         */
       
    94         RCseSchedulerClient* iClient; 
       
    95 
       
    96     };
       
    97 
       
    98 #endif // __RCSESCHEDULERSERVICEBASE_H
       
    99 
       
   100 // End of File
       
   101 
       
   102