os/ossrv/lowlevellibsandfws/pluginfw/Group/ecompatchconstants.hby
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of the License "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// ROM-specific macros for syslibs_ecom component.
sl@0
    15
// Intended for customisation by phone manufacturers.
sl@0
    16
// Read ECOM How To FAQ.doc if need more information about the
sl@0
    17
// patchable constants listed below.
sl@0
    18
// 
sl@0
    19
//
sl@0
    20
sl@0
    21
#ifndef __ECOMPATCHCONSTANTS_HBY__
sl@0
    22
#define __ECOMPATCHCONSTANTS_HBY__
sl@0
    23
sl@0
    24
sl@0
    25
// Macro ECOM_PATCHDATA_KLISTIMPLBUFFERSIZE represents the
sl@0
    26
// value of the patchable constant KListImplBufferSize. It is used
sl@0
    27
// to define the size of the buffer that is pre-allocated on the
sl@0
    28
// ECOM client side to hold data returned by the
sl@0
    29
// REComSession::ListImplementations() API. ECOM How To FAQ
sl@0
    30
// explains how to determine the optimum value for this constant.
sl@0
    31
// The default value of KListImplBufferSize is 2048.
sl@0
    32
// 
sl@0
    33
// This patchable constant was first introduced in Symbian_OS_v9.3.
sl@0
    34
// At that time ECOM How To FAQ advised device builders to use
sl@0
    35
// the "patchdata" command directly in any obey file to patch this
sl@0
    36
// constant. The old scheme has been deprecated and the macro below
sl@0
    37
// is the supported published mechanism for changing this patchable
sl@0
    38
// constant. Please ensure that if this constant
sl@0
    39
// is patched in another obey file, do not uncomment the macro
sl@0
    40
// definition below. Otherwise this constant will be patched twice
sl@0
    41
// with unpredictable result.
sl@0
    42
//
sl@0
    43
// To patch this constant, remove the comment characters and replace 2048
sl@0
    44
// with the desired value.
sl@0
    45
sl@0
    46
// #define ECOM_PATCHDATA_KLISTIMPLBUFFERSIZE 2048
sl@0
    47
sl@0
    48
sl@0
    49
// Macro ECOM_PATCHDATA_KDISCOVERYDISABLEDDRIVELIST represents the
sl@0
    50
// value of the patchable constant KDiscoveryDisabledDriveList.
sl@0
    51
// This constant lets licensees specify a list of drives which they
sl@0
    52
// do not want ECOM to scan, e.g. because the drives can never have
sl@0
    53
// valid plug-ins. 
sl@0
    54
// This is a 32-bit integer with each bit representing a drive to disable:
sl@0
    55
// 0x1 disables drive A, 0x2 disables drive B etc. There are only 25 drive
sl@0
    56
// letters supported (A:->Y:) therefore the last 7 bits are ignored.
sl@0
    57
// Note that Read-only internal drives cannot be disabled.
sl@0
    58
// The default value of KDiscoveryDisabledDriveList is 0, meaning all
sl@0
    59
// drives are enabled.
sl@0
    60
//
sl@0
    61
// To patch this constant, remove the comment characters and replace 0
sl@0
    62
// with the desired value.
sl@0
    63
sl@0
    64
// #define ECOM_PATCHDATA_KDISCOVERYDISABLEDDRIVELIST 0x0
sl@0
    65
sl@0
    66
sl@0
    67
sl@0
    68
// Macro ECOM_PATCHDATA_KCUSTOMRESOLVERCACHESIZE represents the
sl@0
    69
// value of the patchable constant KCustomResolverCacheSize.
sl@0
    70
// This constant specifies the maximum number of resolver DLLs ECOM can cache.
sl@0
    71
// When the cache queue is full, the next custom resolver DLL requested by
sl@0
    72
// client will bump off the oldest DLL in the cache.
sl@0
    73
// The default value of KCustomResolverCacheSize is 4, meaning ECOM will
sl@0
    74
// cache maximum of four resolver DLLs.
sl@0
    75
//
sl@0
    76
// To patch this constant, remove the comment characters and replace 4
sl@0
    77
// with the desired value.
sl@0
    78
sl@0
    79
// #define ECOM_PATCHDATA_KCUSTOMRESOLVERCACHESIZE 4
sl@0
    80
sl@0
    81
sl@0
    82
sl@0
    83
// Macro ECOM_PATCHDATA_KCUSTOMRESOLVERCACHETIMEOUT represents the
sl@0
    84
// value of the patchable constant KCustomResolverCacheTimeout.
sl@0
    85
// This constant specifies the timeout in microseconds that a resolver DLL is
sl@0
    86
// kept in cache. When the time expires, the resolver DLL is released from
sl@0
    87
// memory. The default value of KCustomResolverCacheTimeout is 4000000.
sl@0
    88
// That means if no client uses a cached resolver DLL, the DLL will be
sl@0
    89
// unloaded after four seconds.
sl@0
    90
//
sl@0
    91
// To patch this constant, remove the comment characters and replace 4000000
sl@0
    92
// with the desired value.
sl@0
    93
sl@0
    94
// #define ECOM_PATCHDATA_KCUSTOMRESOLVERCACHETIMEOUT 4000000
sl@0
    95
sl@0
    96
#endif