mmapdatf.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:5k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef UNIX_MMAPDATF_H
  36. #define UNIX_MMAPDATF_H
  37. #include "hxtypes.h"
  38. #include "hxcom.h"
  39. #include "hxdataf.h"
  40. #include "mmapmgr.h"
  41. class MemoryMapDataFile : public IHXDataFile
  42. {
  43. public:
  44. MemoryMapDataFile(IUnknown* pContext,
  45.     REF(IUnknown*) pPersistantObject,
  46.     BOOL bDisableMemoryMappedIO = FALSE,
  47.     UINT32 ulChunkSize = 0,
  48.     BOOL bEnableFileLocking = FALSE);
  49.     virtual ~MemoryMapDataFile();
  50.     /*
  51.      *  IUnknown methods
  52.      */
  53.     STDMETHOD(QueryInterface) (THIS_
  54. REFIID riid,
  55. void** ppvObj);
  56.     
  57.     STDMETHOD_(ULONG32, AddRef) (THIS);
  58.     
  59.     STDMETHOD_(ULONG32, Release) (THIS);
  60.     
  61.     /*
  62.      *  IHXDataFile methods
  63.      */
  64.     /* Bind DataFile Object with FileName */
  65.     STDMETHOD_(void, Bind) (THIS_
  66. const char* FileName);
  67.     /* Creates a datafile using the specified mode
  68.      * uOpenMode --- File Open mode - HX_FILE_READ/HX_FILE_WRITE/HX_FILE_BINARY
  69.      */
  70.     STDMETHOD(Create) (THIS_
  71. UINT16 uOpenMode);
  72.     /* Open will open a file with the specified mode
  73.      */
  74.     STDMETHOD(Open) (THIS_
  75. UINT16 uOpenMode);
  76.     /* Close closes a file 
  77.      * If the reference count on the IHXDataFile object is greater than 1, 
  78.      * then the underlying file cannot be safely closed, so Close() becomes 
  79.      * a noop in that case. Close it only when the object is destroyed. 
  80.      * This would be safe, but could lead to a file descriptor leak.
  81.      */
  82.     STDMETHOD(Close) (THIS);
  83.     /* Name returns the currently bound file name in FileName.
  84.      * and returns TRUE, if the a name has been bound.  Otherwise
  85.      * FALSE is returned.
  86.      */
  87.     STDMETHOD_(BOOL, Name) (THIS_
  88. REF(IHXBuffer*) pFileName);
  89.     /*
  90.      * IsOpen returns TRUE if file is open.  Otherwise FALSE.
  91.      */
  92.     STDMETHOD_(BOOL, IsOpen) (THIS);
  93.     /* Seek moves the current file position to the offset from the
  94.      * fromWhere specifier returns current position of file or -1 on
  95.      * error.
  96.      */
  97.     STDMETHOD(Seek) (THIS_
  98. ULONG32 offset, UINT16 fromWhere);
  99.     /* Tell returns the current file position in the file */
  100.     STDMETHOD_(ULONG32, Tell) (THIS);
  101.     /* Read reads up to count bytes of data into buf.
  102.      * returns the number of bytes read, EOF, or -1 if the read failed 
  103.      */
  104.     STDMETHOD_(ULONG32, Read) (THIS_
  105. REF(IHXBuffer*) pBuf, 
  106. ULONG32 count);
  107.     /* Write writes up to count bytes of data from buf.
  108.      * returns the number of bytes written, or -1 if the write failed 
  109.      */
  110.     STDMETHOD_(ULONG32, Write) (THIS_
  111. REF(IHXBuffer*) pBuf); 
  112.     /* Flush out the data in case of unbuffered I/O
  113.      */
  114.     STDMETHOD(Flush) (THIS);
  115.     /*
  116.      * Return info about the data file such as permissions, time of creation
  117.      * size in bytes, etc.
  118.      */
  119.     STDMETHOD(Stat) (THIS_
  120. struct stat* buffer);
  121.     /* Delete File */
  122.     STDMETHOD(Delete) (THIS);
  123.     /* Return the file descriptor */
  124.     STDMETHOD_(INT16, GetFd) (THIS);
  125.     /* GetLastError returns the platform specific file error */
  126.     STDMETHOD(GetLastError) (THIS);
  127.     /* GetLastError returns the platform specific file error in
  128.      * string form.
  129.      */
  130.     STDMETHOD_(void, GetLastError) (THIS_
  131. REF(IHXBuffer*) err);
  132.     void StopMmap();
  133.     BOOL LockFile();
  134.     BOOL UnlockFile();
  135. protected:
  136.     LONG32 m_lRefCount;
  137.     UINT32 m_ulLastError;
  138.     IHXBuffer* m_pFilename;
  139.     int m_nFD;
  140.     void* MmapHandle;
  141.     UINT32 m_ulPos;
  142.     UINT32 m_ulFilePointerPos;
  143.     MemoryMapManager* m_pMMM;
  144.     IUnknown* m_pContext;
  145.     UINT32 m_ulChunkSize;
  146.     BOOL m_bEnableFileLocking;
  147.     BOOL m_bLockedIt;
  148. };
  149. #endif /* UNIX_MMAPDATF_H */