satengine/satserver/inc/CSatSScheduler.h
author hgs
Fri, 15 Oct 2010 13:21:28 +0300
changeset 53 25b8d29b7c59
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  This is the active scheduler of the SAT Server.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef CSATSSCHEDULER_H
hgs
parents:
diff changeset
    20
#define CSATSSCHEDULER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// INCLUDE FILES
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    26
class CSatSServer;
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
//  CLASS DECLARATION
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
/**
hgs
parents:
diff changeset
    31
*  SAT Server includes a scheduler of it's own to simplify
hgs
parents:
diff changeset
    32
*  client request handling code. All active object leaves are
hgs
parents:
diff changeset
    33
*  handled in function Error(). The behaviour of Error()
hgs
parents:
diff changeset
    34
*  depends on whether there is an outstanding client request
hgs
parents:
diff changeset
    35
*  or not: it will tell the client the reason for inability
hgs
parents:
diff changeset
    36
*  to handle the client request. It will also panic the
hgs
parents:
diff changeset
    37
*  client if the descriptor passed to the server was malformed.
hgs
parents:
diff changeset
    38
*  Finally, a panic is raised if the error does not originate
hgs
parents:
diff changeset
    39
*  from the server itself.
hgs
parents:
diff changeset
    40
*
hgs
parents:
diff changeset
    41
*  @lib SatEngine
hgs
parents:
diff changeset
    42
*  @since Series 60 3.0
hgs
parents:
diff changeset
    43
*/
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
class CSatSScheduler : public CActiveScheduler
hgs
parents:
diff changeset
    46
    {
hgs
parents:
diff changeset
    47
    public: // Constructors
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
        /**
hgs
parents:
diff changeset
    50
        *   Default constructor
hgs
parents:
diff changeset
    51
        */
hgs
parents:
diff changeset
    52
        IMPORT_C CSatSScheduler();
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
        /**
hgs
parents:
diff changeset
    55
        *   Gives a pointer of the current CSatSServer instance
hgs
parents:
diff changeset
    56
        *   to the scheduler.
hgs
parents:
diff changeset
    57
        *   @param aServer The current server pointer
hgs
parents:
diff changeset
    58
        */
hgs
parents:
diff changeset
    59
        IMPORT_C void SetServer( CSatSServer* aServer );
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
    public:     // from CActiveScheduler
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
        /**
hgs
parents:
diff changeset
    64
        *   Overridden to handle leaves in request functions and
hgs
parents:
diff changeset
    65
        *   unexpected situations.
hgs
parents:
diff changeset
    66
        *   @param aError Error code, see EPOC system documentation.
hgs
parents:
diff changeset
    67
        */
hgs
parents:
diff changeset
    68
        void Error( TInt aError ) const;
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
    private:    // prohibited operators and functions
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
        // Copy constructor
hgs
parents:
diff changeset
    73
        CSatSScheduler( const CSatSScheduler& );
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
        // Assignment operator
hgs
parents:
diff changeset
    76
        CSatSScheduler& operator=( const CSatSScheduler& );
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
    private:    // data
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
        // Ref: server instance
hgs
parents:
diff changeset
    81
        CSatSServer* iServer;
hgs
parents:
diff changeset
    82
    };
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
#endif          // CSATSSCHEDULER_H
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
// End of File