sdkcreationmw/sdkruntimes/FileLoader/inc/W32FileReader.h
author Shabe Razvi <shaber@symbian.org>
Thu, 04 Nov 2010 17:22:05 +0000
changeset 4 b3b823debf08
parent 0 b26acd06ea60
permissions -rw-r--r--
Workaround for Bug 3917 - CWinsockInterface::DataSent calls NotifyDataSent which is not implemented.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     1
/*
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     3
* All rights reserved.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     4
* This component and the accompanying materials are made available
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     6
* which accompanies this distribution, and is available
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     8
*
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
     9
* Initial Contributors:
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    11
*
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    12
* Contributors:
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    13
*
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    14
* Description:
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    15
*
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    16
*/
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    17
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    18
#ifndef __W32FILEREADER_H_
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    19
#define __W32FILEREADER_H_
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    20
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    21
//  INCLUDES
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    22
#include <e32base.h>
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    23
#include <emulator.h>
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    24
// CONSTANTS
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    25
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    26
// MACROS
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    27
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    28
// FUNCTION PROTOTYPES
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    29
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    30
// FORWARD DECLARATIONS
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    31
class CW32FileConnection;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    32
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    33
// CLASS DECLARATION
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    34
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    35
/**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    36
*  This is a simple incremental file reader.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    37
*  @lib resLoader.lib
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    38
*  @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    39
*/
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    40
class CW32FileReader : public CActive
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    41
    {
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    42
    public:  // Constructors and destructor        
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    43
        
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    44
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    45
        * Two-phased constructor.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    46
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    47
        * @param aFile File to read.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    48
        * @param aChunkSize Chunk size to be read in one turn.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    49
        * @param aFileReaderCallback Observer object-file transaction.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    50
        * @return File reader object
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    51
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    52
        static CW32FileReader* NewL( HANDLE aFh, TInt aChunkSize, CW32FileConnection* aFileConnection );
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    53
        
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    54
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    55
        * Destructor.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    56
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    57
        virtual ~CW32FileReader();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    58
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    59
    public: // New functions
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    60
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    61
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    62
        * Start reading the file from the beginning.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    63
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    64
        * @param 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    65
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    66
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    67
        void StartReading();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    68
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    69
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    70
        * Stop reading 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    71
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    72
        * @param 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    73
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    74
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    75
        void StopReading();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    76
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    77
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    78
        * Get partial body buffer.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    79
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    80
        * @param aChunkBuffer Pointer to the partial body buffer
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    81
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    82
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    83
        void GetChunkBuffer( TPtrC8& aChunkBuffer );
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    84
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    85
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    86
        * Purge the chunk buffer.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    87
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    88
        * @param 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    89
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    90
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    91
        void ReleaseChunkBuffer();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    92
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    93
    public: // from CActive
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    94
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    95
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    96
        * Cancel active object
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    97
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    98
        * @param
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
    99
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   100
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   101
        void DoCancel();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   102
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   103
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   104
        * Asynchronous handling of transaction events.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   105
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   106
        * @param 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   107
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   108
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   109
        void RunL();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   110
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   111
    private:
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   112
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   113
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   114
        * Construct.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   115
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   116
        * @param aFile File to read.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   117
        * @param aChunkSize Chunk size to be read in one turn.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   118
        * @param aFileReaderCallback Observer object-file transaction.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   119
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   120
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   121
        CW32FileReader( HANDLE aFh, TInt aChunkSize, CW32FileConnection* aFileConnection );
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   122
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   123
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   124
        * By default Symbian 2nd phase constructor is private.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   125
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   126
        void ConstructL();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   127
    
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   128
        /**
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   129
        * Read from the file from the current position.
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   130
        * @since 3.1
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   131
        * @param 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   132
        * @return void
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   133
        */
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   134
        void ReadFile();
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   135
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   136
    private:    // Data
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   137
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   138
        // file to read
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   139
		HANDLE iFh; //file handle
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   140
        // actual file position 
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   141
        TInt          m_filePos;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   142
        // chunk size to read in one turn
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   143
        TInt          m_chunkSize;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   144
        // chunk buffer
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   145
        HBufC8*       m_chunkBuffer;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   146
        // observer object
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   147
        CW32FileConnection* m_fileConnection;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   148
        // pointer to the chunk buffer
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   149
        TPtr8         m_chunkBufPtr;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   150
        // ETrue if the file transaction is cancelled
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   151
        TBool         m_stopReading;
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   152
  };
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   153
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   154
#endif      // __W32FILEREADER_H__
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   155
            
b26acd06ea60 First Contribution of SDK components
rajpuroh
parents:
diff changeset
   156
// End of File