|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-C45CE452-7260-5062-B14B-8445E6767DA3" xml:lang="en"><title>Patchable |
|
13 Constants: KShtdwnTimeoutClient</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <codeblock id="GUID-671FBA2A-E44A-5FD3-A807-FA4200C8BD0B" xml:space="preserve">EXPORT_C extern const TInt32 KShtdwnTimeoutClient = 500000;</codeblock> |
|
15 <table id="GUID-F93B3164-76D1-58A5-9DC6-2440D2FEA9FD"> |
|
16 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
17 <tbody> |
|
18 <row> |
|
19 <entry><p>Exported from: </p> </entry> |
|
20 <entry><p> <filepath>shutdownsrv.dll</filepath> </p> </entry> |
|
21 </row> |
|
22 <row> |
|
23 <entry><p>Defined in: </p> </entry> |
|
24 <entry><p> <filepath> .../os/devicesrv/resourcemgmt/powerandmemorynotificationservice/src/shutdownsrvpatchdata.cpp</filepath> </p> </entry> |
|
25 </row> |
|
26 <row> |
|
27 <entry><p>Purpose: </p> </entry> |
|
28 <entry><p>This constant represents the timeout value for each client in microseconds. |
|
29 The shutdown server uses it and <codeph>KShtdwnTimeoutBase</codeph> to calculate |
|
30 the shutdown timer. The timeout is calculated as </p> <codeblock id="GUID-B040CD7C-5674-5983-B5A4-649C2B941732" xml:space="preserve">KShtdwnTimeoutBase + KShtdwnTimeoutClient * numClients</codeblock> <p>where <codeph>numClients</codeph> is the number of connecting clients. </p> </entry> |
|
31 </row> |
|
32 </tbody> |
|
33 </tgroup> |
|
34 </table> |
|
35 <p>If the timeout value is </p> |
|
36 <ul> |
|
37 <li id="GUID-2655B6B0-9010-5BDD-A73A-979471F0A35C"><p> <codeph>-1</codeph> the |
|
38 timer is not used and the server will wait for all client registrations before |
|
39 executing the shutdown, </p> </li> |
|
40 <li id="GUID-F8F7AD46-D83A-518C-A3A6-87C8B3187350"><p> <codeph> 0</codeph> the |
|
41 timer expires immediately and the server will execute the shutdown immediately |
|
42 not waiting for any client re-registration, or </p> </li> |
|
43 <li id="GUID-DDE5AB27-223B-541C-A3C4-08B1FBCE5E19"><p>greater than <codeph>0</codeph> the |
|
44 server will wait a certain period of time for the client registrations and |
|
45 execute the shutdown if the timer expires or all clients re-register. </p> </li> |
|
46 </ul> |
|
47 <p> <codeph>KShtdwnTimeoutClient</codeph> is an internal constant and should |
|
48 not be directly modified. Device creators who wish to alter <codeph>KShtdwnTimeoutClient</codeph> and <codeph>KShtdwnTimeoutBase</codeph> should |
|
49 define these ROM build-time macros in their product HRH or IBY files: </p> |
|
50 <ul> |
|
51 <li id="GUID-379D9AED-0C41-5283-9B33-EF4BC0CBFB27"><p> <codeph>SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTBASE</codeph> with |
|
52 value >= -1, </p> </li> |
|
53 <li id="GUID-9299DE1B-3D7C-5928-884B-8211979DB7A4"><p> <codeph> SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTCLIENT</codeph> with |
|
54 value >= 0. </p> </li> |
|
55 </ul> |
|
56 <p>If values fall outside the specified ranges, the server panics with <codeph>KErrNotSupported</codeph>. </p> |
|
57 </conbody></concept> |