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

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 _DATAFILE_H_
  36. #define _DATAFILE_H_
  37. typedef _INTERFACE IUnknown IUnknown;
  38. typedef _INTERFACE IHXBuffer IHXBuffer;
  39. typedef _INTERFACE IHXDataFile IHXDataFile;
  40. typedef _INTERFACE IHXDataFileFactory IHXDataFileFactory;
  41. typedef _INTERFACE IHXCallback IHXCallback;
  42. enum 
  43. {
  44.     HX_FILEFLAG_READ = 1,
  45.     HX_FILEFLAG_WRITE = 2,
  46.     HX_FILEFLAG_BINARY = 4,
  47.     HX_FILEFLAG_NOTRUNC = 8
  48. };
  49. /*
  50.  * 
  51.  *  Interface:
  52.  *
  53.  * IHXDataFileFactory
  54.  *
  55.  *  Purpose:
  56.  *
  57.  * This interface provides an API for creating datafile objects
  58.  *      based on passed in options and platform compiled for.
  59.  *
  60.  * IHXDataFileFactory
  61.  * |
  62.  * IHXDataFile
  63.  * |__________________________________________________...
  64.  * | |                |                |
  65.  * Buffered UnBuffered       Mem.Mapped       Async
  66.  *
  67.  *  IID_IHXDataFileFactory: {00000F00-0901-11d1-8B06-00A024406D59}
  68.  *
  69.  */
  70. DEFINE_GUID(IID_IHXDataFileFactory, 0x00000F00, 0xb4c8, 0x11d0, 0x99, 0x95, 
  71. 0x0, 0xa0, 0x24, 0x8d, 0xa5, 0xf0);
  72. #undef  INTERFACE
  73. #define INTERFACE   IHXDataFileFactory
  74. DECLARE_INTERFACE_(IHXDataFileFactory, IUnknown)
  75. {
  76.     /*
  77.      *  IUnknown methods
  78.      */
  79.     STDMETHOD(QueryInterface) (THIS_
  80. REFIID riid,
  81. void** ppvObj) PURE;
  82.     
  83.     STDMETHOD_(ULONG32, AddRef) (THIS) PURE;
  84.     
  85.     STDMETHOD_(ULONG32, Release) (THIS) PURE;
  86.     
  87.     /*
  88.      *  IHXDataFileFactory methods
  89.      */
  90.     /* Creates a datafile for buffered or unbuffered I/O
  91.      * By default create an IHXDataFile for BUFFERED file I/O 
  92.      * for all platforms, except SOLARIS, where UNBUFFERED 
  93.      * file I/O is required.
  94.      */
  95.     STDMETHOD(CreateFile) (THIS_
  96. REF(IHXDataFile*) pDataFile,
  97. IUnknown*  pContext,
  98. REF(IUnknown*) pPersistantObject,
  99. BOOL bDisableMemoryMappedIO,
  100. UINT32 ulChunkSize,
  101. BOOL bEnableFileLocking,
  102. BOOL bPreferAsyncIO
  103. ) PURE;
  104. };
  105. /*
  106.  * 
  107.  *  Interface:
  108.  *
  109.  * IHXDataFile
  110.  *
  111.  *  Purpose:
  112.  *
  113.  * This interface provides an API for basic file access to datafiles. 
  114.  * The datafile object is crated based on passed in options and
  115.  * platform compiled for.
  116.  *
  117.  * IHXDataFileFactory
  118.  * |
  119.  * IHXDataFile
  120.  * |__________________________________________________...
  121.  * | |                |                |
  122.  * Buffered UnBuffered       Mem.Mapped       Async
  123.  *
  124.  *  IID_IHXDataFile:        {00000F01-0901-11d1-8B06-00A024406D59}
  125.  *
  126.  */
  127. DEFINE_GUID(IID_IHXDataFile, 0x00000F01, 0xb4c8, 0x11d0, 0x99, 0x95, 
  128. 0x0, 0xa0, 0x24, 0x8d, 0xa5, 0xf0);
  129. #undef  INTERFACE
  130. #define INTERFACE   IHXDataFile
  131. DECLARE_INTERFACE_(IHXDataFile, IUnknown)
  132. {
  133.     /*
  134.      *  IUnknown methods
  135.      */
  136.     STDMETHOD(QueryInterface) (THIS_
  137. REFIID riid,
  138. void** ppvObj) PURE;
  139.     
  140.     STDMETHOD_(ULONG32, AddRef) (THIS) PURE;
  141.     
  142.     STDMETHOD_(ULONG32, Release) (THIS) PURE;
  143.     
  144.     /*
  145.      *  IHXDataFile methods
  146.      */
  147.     /* Bind DataFile Object with FileName */
  148.     STDMETHOD_(void, Bind) (THIS_
  149. const char* FileName) PURE;
  150.     /* Creates a datafile using the specified mode
  151.      * uOpenMode --- File Open mode - HX_FILE_READ/HX_FILE_WRITE/HX_FILE_BINARY
  152.      */
  153.     STDMETHOD(Create) (THIS_
  154. UINT16 uOpenMode) PURE;
  155.     /* Open will open a file with the specified mode
  156.      */
  157.     STDMETHOD(Open) (THIS_
  158. UINT16 uOpenMode) PURE;
  159.     /* Close closes a file 
  160.      * If the reference count on the IHXDataFile object is greater than 1, 
  161.      * then the underlying file cannot be safely closed, so Close() becomes 
  162.      * a noop in that case. Close it only when the object is destroyed. 
  163.      * This would be safe, but could lead to a file descriptor leak.
  164.      */
  165.     STDMETHOD(Close) (THIS) PURE;
  166.     /* Name returns the currently bound file name in FileName.
  167.      * and returns TRUE, if the a name has been bound.  Otherwise
  168.      * FALSE is returned.
  169.      */
  170.     STDMETHOD_(BOOL, Name) (THIS_
  171. REF(IHXBuffer*) pFileName) PURE;
  172.     /*
  173.      * IsOpen returns TRUE if file is open.  Otherwise FALSE.
  174.      */
  175.     STDMETHOD_(BOOL, IsOpen) (THIS) PURE;
  176.     /* Seek moves the current file position to the offset from the
  177.      * fromWhere specifier returns current position of file or -1 on
  178.      * error.
  179.      */
  180.     STDMETHOD(Seek) (THIS_
  181. ULONG32 offset, UINT16 fromWhere) PURE;
  182.     /* Tell returns the current file position in the file */
  183.     STDMETHOD_(ULONG32, Tell) (THIS) PURE;
  184.     /* Read reads up to count bytes of data into buf.
  185.      * returns the number of bytes read, EOF, or -1 if the read failed 
  186.      */
  187.     STDMETHOD_(ULONG32, Read) (THIS_
  188. REF(IHXBuffer*) pBuf, 
  189. ULONG32 count) PURE;
  190.     /* Write writes up to count bytes of data from buf.
  191.      * returns the number of bytes written, or -1 if the write failed 
  192.      */
  193.     STDMETHOD_(ULONG32, Write) (THIS_
  194. REF(IHXBuffer*) pBuf) PURE;
  195.     /* Flush out the data in case of unbuffered I/O
  196.      */
  197.     STDMETHOD(Flush) (THIS) PURE;
  198.     /*
  199.      * Return info about the data file such as permissions, time of creation
  200.      * size in bytes, etc.
  201.      */
  202.     STDMETHOD(Stat) (THIS_
  203. struct stat* buffer) PURE;
  204.     /* Delete File */
  205.     STDMETHOD(Delete) (THIS) PURE;
  206.     /* Return the file descriptor */
  207.     STDMETHOD_(INT16, GetFd) (THIS) PURE;
  208.     /* GetLastError returns the platform specific file error */
  209.     STDMETHOD(GetLastError) (THIS) PURE;
  210.     /* GetLastError returns the platform specific file error in
  211.      * string form.
  212.      */
  213.     STDMETHOD_(void, GetLastError) (THIS_
  214. REF(IHXBuffer*) err) PURE;
  215. };
  216. /*
  217.  * 
  218.  *  Interface:
  219.  *
  220.  * IID_IHXAsyncDataFile
  221.  *
  222.  *  Purpose:
  223.  *
  224.  * This interface provides an API for basic data file operations and
  225.  *  asynchronous read, write and seek operations.
  226.  *
  227.  */
  228. DEFINE_GUID(IID_IHXAsyncDataFile,   0x972bacc0, 0xaff, 0x11d7, 0xac, 
  229.     0x45, 0x0, 0x1, 0x2, 0x51, 0xb3, 0x40);
  230. #undef  INTERFACE
  231. #define INTERFACE   IHXAsyncDataFile
  232. DECLARE_INTERFACE_(IHXAsyncDataFile, IHXDataFile)
  233. {
  234.     /*
  235.      *  IUnknown methods
  236.      */
  237.     STDMETHOD(QueryInterface) (THIS_
  238. REFIID riid,
  239. void** ppvObj) PURE;
  240.     
  241.     STDMETHOD_(ULONG32, AddRef) (THIS) PURE;
  242.     
  243.     STDMETHOD_(ULONG32, Release) (THIS) PURE;
  244.     
  245.     /*
  246.      *  IHXDataFile methods
  247.      */
  248.     /* Bind DataFile Object with FileName */
  249.     STDMETHOD_(void, Bind) (THIS_
  250. const char* FileName) PURE;
  251.     /* Creates a datafile using the specified mode
  252.      * uOpenMode --- File Open mode - HX_FILE_READ/HX_FILE_WRITE/HX_FILE_BINARY
  253.      */
  254.     STDMETHOD(Create) (THIS_
  255. UINT16 uOpenMode) PURE;
  256.     /* Open will open a file with the specified mode
  257.      */
  258.     STDMETHOD(Open) (THIS_
  259. UINT16 uOpenMode) PURE;
  260.     /* Close closes a file 
  261.      * If the reference count on the IHXDataFile object is greater than 1, 
  262.      * then the underlying file cannot be safely closed, so Close() becomes 
  263.      * a noop in that case. Close it only when the object is destroyed. 
  264.      * This would be safe, but could lead to a file descriptor leak.
  265.      */
  266.     STDMETHOD(Close) (THIS) PURE;
  267.     /* Name returns the currently bound file name in FileName.
  268.      * and returns TRUE, if the a name has been bound.  Otherwise
  269.      * FALSE is returned.
  270.      */
  271.     STDMETHOD_(BOOL, Name) (THIS_
  272. REF(IHXBuffer*) pFileName) PURE;
  273.     /*
  274.      * IsOpen returns TRUE if file is open.  Otherwise FALSE.
  275.      */
  276.     STDMETHOD_(BOOL, IsOpen) (THIS) PURE;
  277.     /* Seek moves the current file position to the offset from the
  278.      * fromWhere specifier returns current position of file or -1 on
  279.      * error.
  280.      */
  281.     STDMETHOD(Seek) (THIS_
  282. ULONG32 offset, UINT16 fromWhere) PURE;
  283.     /* Tell returns the current file position in the file */
  284.     STDMETHOD_(ULONG32, Tell) (THIS) PURE;
  285.     /* Read reads up to count bytes of data into buf.
  286.      * returns the number of bytes read, EOF, or -1 if the read failed 
  287.      */
  288.     STDMETHOD_(ULONG32, Read) (THIS_
  289. REF(IHXBuffer*) pBuf, 
  290. ULONG32 count) PURE;
  291.     /* Write writes up to count bytes of data from buf.
  292.      * returns the number of bytes written, or -1 if the write failed 
  293.      */
  294.     STDMETHOD_(ULONG32, Write) (THIS_
  295. REF(IHXBuffer*) pBuf) PURE;
  296.     /* Flush out the data in case of unbuffered I/O
  297.      */
  298.     STDMETHOD(Flush) (THIS) PURE;
  299.     /*
  300.      * Return info about the data file such as permissions, time of creation
  301.      * size in bytes, etc.
  302.      */
  303.     STDMETHOD(Stat) (THIS_
  304. struct stat* buffer) PURE;
  305.     /* Delete File */
  306.     STDMETHOD(Delete) (THIS) PURE;
  307.     /* Return the file descriptor */
  308.     STDMETHOD_(INT16, GetFd) (THIS) PURE;
  309.     /* GetLastError returns the platform specific file error */
  310.     STDMETHOD(GetLastError) (THIS) PURE;
  311.     /* GetLastError returns the platform specific file error in
  312.      * string form.
  313.      */
  314.     STDMETHOD_(void, GetLastError) (THIS_
  315. REF(IHXBuffer*) err) PURE;
  316.     /*
  317.      *  IHXAsyncDataFile
  318.      */
  319.     STDMETHOD(SetReceiver) (THIS_
  320. IHXCallback* pCallback) PURE;
  321.     STDMETHOD(SeekAsync) (THIS_
  322. REF(HX_RESULT) status, 
  323. ULONG32 offset, UINT16 fromWhere) PURE;
  324.     STDMETHOD(ReadAsync) (THIS_
  325. REF(ULONG32) ulReadSize,
  326. REF(IHXBuffer*) pBuf, 
  327. ULONG32 count) PURE;
  328.     STDMETHOD(WriteAsync) (THIS_
  329. REF(ULONG32) ulWrittenSize,
  330. REF(IHXBuffer*) pBuf) PURE;
  331. };
  332. #if defined(_SYMBIAN)
  333. #include "platform/symbian/ihxsymbfsessionmgr.h"
  334. #endif // _SYMBIAN
  335. #endif /* _DATAFILE_H_ */