Collapse all Symbian^3 Product Developer Library

Patchable Constants: KShtdwnTimeoutBase

EXPORT_C extern const TInt32 KShtdwnTimeoutBase = 1000000;

Exported from:

shutdownsrv.dll

Defined in:

.../os/devicesrv/resourcemgmt/powerandmemorynotificationservice/src/shutdownsrvpatchdata.cpp

Purpose:

This constant represents the base timeout value in microseconds. The shutdown server uses it and KShtdwnTimeoutClient to calculate the shutdown timer. The timeout is calculated as

KShtdwnTimeoutBase + KShtdwnTimeoutClient * numClients

where numClients is the number of connecting clients.

If the timeout value is

-1 the timer is not used and the server will wait for all client registrations before executing the shutdown,
0 the timer expires immediately and the server will execute the shutdown immediately not waiting for any client re-registration, or
greater than 0 the server will wait a certain period of time for the client registrations and execute the shutdown if the timer expires or all clients re-register.

KShtdwnTimeoutBase is an internal constant and should not be directly modified. Device creators who wish to alter KShtdwnTimeoutClient and KShtdwnTimeoutBase should define these ROM build-time macros in their product HRH or IBY files:

SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTBASE with value >= -1,
SYMBIAN_PWRCLI_PATCHDATA_KSHTDWNTIMEOUTCLIENT with value >= 0.

If values fall outside the specified ranges, the server panics with KErrNotSupported.

Parent topic: Patchable Constants