os/persistentdata/persistentstorage/store/BMAKE/EStor_Template.mmh
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 // Copyright (c) 2005-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 // ESTOR.MMH
    15 // estor.mmh Stream store management - default file buffer size,
    16 // max read ahead value and file block size.
    17 // This file is an example file that may be copied, modified and 
    18 // installed as \epoc32\include\Estor.mmh file to customise buffer handling
    19 // in the Store component. Also, SYMBIAN_CUSTOM_STORE_BUFFER_SIZES must be 
    20 // defined in the related \epoc32\include\variant\Symbian_OS_v<N>.hrh file,
    21 // where <N> is the OS version number, like 9.1.
    22 // This file is not expected to be directly modified.
    23 // NOTE: Changing the value of these macros will affect RAM usage in 
    24 // store/stream processing system wide and should not be undertaken lightly.
    25 // Default file buffer size in bytes used in RFileBuf objects.
    26 // It can't be less than 1536 bytes. 
    27 // 
    28 //
    29 
    30 /**
    31  @file
    32  @publishedPartner
    33 */
    34 MACRO DEFAULT_FILE_BUF_SIZE=4096
    35 
    36 /**
    37 Maximum RFileBuf read ahead value in bytes. This defines the number of bytes
    38 read into the file buffer when buffer underflow occurs.
    39 It can't be less than 512 bytes and must not be greater 
    40 than DEFAULT_FILE_BUF_SIZE.
    41 @publishedPartner
    42 */
    43 MACRO MAX_READ_AHEAD_VALUE=2048
    44 
    45 /**
    46 File system block size to be assumed by RFileBuf. It is used in buffer underflow
    47 to perform block aligned reads to load the buffer.
    48 It can't be less than 512 bytes and must not be greater
    49 then MAX_READ_AHEAD_VALUE. Also, FILE_BLOCK_SIZE value must be power of 2.
    50 @publishedPartner
    51 */
    52 MACRO FILE_BLOCK_SIZE=1024
    53