satengine/SatServer/inc/CSatSScheduler.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2002-2005 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 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  This is the active scheduler of the SAT Server.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CSATSSCHEDULER_H
       
    20 #define CSATSSCHEDULER_H
       
    21 
       
    22 // INCLUDE FILES
       
    23 #include <e32base.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class CSatSServer;
       
    27 
       
    28 //  CLASS DECLARATION
       
    29 
       
    30 /**
       
    31 *  SAT Server includes a scheduler of it's own to simplify
       
    32 *  client request handling code. All active object leaves are
       
    33 *  handled in function Error(). The behaviour of Error()
       
    34 *  depends on whether there is an outstanding client request
       
    35 *  or not: it will tell the client the reason for inability
       
    36 *  to handle the client request. It will also panic the
       
    37 *  client if the descriptor passed to the server was malformed.
       
    38 *  Finally, a panic is raised if the error does not originate
       
    39 *  from the server itself.
       
    40 *
       
    41 *  @lib SatEngine
       
    42 *  @since Series 60 3.0
       
    43 */
       
    44 
       
    45 class CSatSScheduler : public CActiveScheduler
       
    46     {
       
    47     public: // Constructors
       
    48 
       
    49         /**
       
    50         *   Default constructor
       
    51         */
       
    52         IMPORT_C CSatSScheduler();
       
    53 
       
    54         /**
       
    55         *   Gives a pointer of the current CSatSServer instance
       
    56         *   to the scheduler.
       
    57         *   @param aServer The current server pointer
       
    58         */
       
    59         IMPORT_C void SetServer( CSatSServer* aServer );
       
    60 
       
    61     public:     // from CActiveScheduler
       
    62 
       
    63         /**
       
    64         *   Overridden to handle leaves in request functions and
       
    65         *   unexpected situations.
       
    66         *   @param aError Error code, see EPOC system documentation.
       
    67         */
       
    68         void Error( TInt aError ) const;
       
    69 
       
    70     private:    // prohibited operators and functions
       
    71 
       
    72         // Copy constructor
       
    73         CSatSScheduler( const CSatSScheduler& );
       
    74 
       
    75         // Assignment operator
       
    76         CSatSScheduler& operator=( const CSatSScheduler& );
       
    77 
       
    78     private:    // data
       
    79 
       
    80         // Ref: server instance
       
    81         CSatSServer* iServer;
       
    82     };
       
    83 
       
    84 #endif          // CSATSSCHEDULER_H
       
    85 
       
    86 // End of File