resourcemgmt/powerandmemorynotificationservice/group/PwrCli.iby
changeset 0 4e1aa6a622a0
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef PWRCLI_IBY
       
    17 #define PWRCLI_IBY
       
    18 
       
    19 REM PwrCli
       
    20 
       
    21 file=ABI_DIR\BUILD_DIR\powermgrcli.dll 	System\Libs\Powermgrcli.dll
       
    22 file=ABI_DIR\BUILD_DIR\shutdownsrv.dll	System\Libs\shutdownsrv.dll
       
    23 file=ABI_DIR\BUILD_DIR\shutdownsrvs.exe	System\Programs\shutdownsrvs.exe
       
    24 
       
    25 
       
    26 /**
       
    27 KShtdwnTimeoutBase and KShtdwnTimeoutClient are patchable constants.
       
    28 They are time values in microseconds to calculate the timeout to limit the 
       
    29 time waited by the server for its clients in the system to complete MSaveObserver 
       
    30 event processing.
       
    31 
       
    32 The timeout is calculated as:
       
    33 KShtdwnTimeoutBase + KShtdwnTimeoutClient * numClients,
       
    34 where numClients is the number of connecting clients.
       
    35 
       
    36 If the timeout value is;
       
    37 -1, the timer is not used, the server will wait for all client's registration 
       
    38     before executing the shutdown;
       
    39 0,  the timer expires immediately, the server will execute the shutdown immediately, 
       
    40     not waiting for any client's re-registration.
       
    41 other value greater than 0, the server will wait a certain period of time for the clients' registration 
       
    42     and execute the shutdown if the timer expires or all clients re-register.
       
    43 
       
    44 These 2 patchable constants have default values:
       
    45 KShtdwnTimeoutBase = 1000000;
       
    46 KShtdwnTimeoutClient = 500000
       
    47 
       
    48 Licensees who wish to alter them will need to define these ROM build-time macros in their 
       
    49 product HRH or IBY files:
       
    50 SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTBASE 
       
    51 SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTCLIENT 
       
    52 
       
    53 The values of the macros must follow the rule:
       
    54 SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTBASE >= -1 and
       
    55 SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTCLIENT >= 0.
       
    56 
       
    57 Otherwise, the server panics with KErrNotSupported. 
       
    58 */
       
    59 #ifdef SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTBASE
       
    60     patchdata shutdownsrv.dll@KShtdwnTimeoutBase SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTBASE
       
    61 #endif
       
    62 #ifdef SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTCLIENT
       
    63     patchdata shutdownsrv.dll@KShtdwnTimeoutClient SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTCLIENT 
       
    64 #endif
       
    65 
       
    66 #endif