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