symbihxdataf.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:7k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: symbihxdataf.h,v 1.3.42.3 2004/07/09 01:44:20 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _SYMBIHXDATAF_H_
  50. #define _SYMBIHXDATAF_H_
  51. /************************************************************************
  52.  *  Includes
  53.  */
  54. #include "hxcom.h"
  55. #include "hxdataf.h"
  56. #include "ihxsymbfsessionmgr.h"
  57. /************************************************************************
  58.  *  CIHX2CHXDataFile
  59.  */
  60. class CSymbIHXDataFile : public IHXAsyncDataFile
  61. {
  62. public:
  63. /*
  64.  *  Constructor
  65.  */
  66. CSymbIHXDataFile(IUnknown** ppCommonObj = NULL);
  67. /*
  68.  *  IHXDataFile methods
  69.  */
  70. /* Bind DataFile Object with FileName */
  71. STDMETHOD_(void, Bind) (THIS_
  72. const char* FileName);
  73. /* Creates a datafile using the specified mode
  74.  * uOpenMode --- File Open mode - HX_FILE_READ/HX_FILE_WRITE/HX_FILE_BINARY
  75.  */
  76. STDMETHOD(Create) (THIS_
  77. UINT16 uOpenMode);
  78. /* Open will open a file with the specified mode
  79.  */
  80. STDMETHOD(Open) (THIS_
  81. UINT16 uOpenMode);
  82. /* Close closes a file 
  83.  * If the reference count on the IHXDataFile object is greater than 1, 
  84.  * then the underlying file cannot be safely closed, so Close() becomes 
  85.  * a noop in that case. Close it only when the object is destroyed. 
  86.  * This would be safe, but could lead to a file descriptor leak.
  87.  */
  88. STDMETHOD(Close) (THIS);
  89. /* Name returns the currently bound file name in FileName.
  90.  * and returns TRUE, if the a name has been bound.  Otherwise
  91.  * FALSE is returned.
  92.  */
  93. STDMETHOD_(BOOL, Name) (THIS_
  94. REF(IHXBuffer*) pFileName);
  95. /*
  96.  * IsOpen returns TRUE if file is open.  Otherwise FALSE.
  97.  */
  98. STDMETHOD_(BOOL, IsOpen) (THIS);
  99. /* Seek moves the current file position to the offset from the
  100.  * fromWhere specifier returns current position of file or -1 on
  101.  * error.
  102.  */
  103. STDMETHOD(Seek) (THIS_
  104. ULONG32 offset, UINT16 fromWhere);
  105. /* Tell returns the current file position in the file */
  106. STDMETHOD_(ULONG32, Tell) (THIS);
  107. /* Read reads up to count bytes of data into buf.
  108.  * returns the number of bytes read, EOF, or -1 if the read failed 
  109.  */
  110. STDMETHOD_(ULONG32, Read) (THIS_
  111. REF(IHXBuffer*) pBuf, 
  112. ULONG32 count);
  113. /* Write writes up to count bytes of data from buf.
  114.  * returns the number of bytes written, or -1 if the write failed 
  115.  */
  116. STDMETHOD_(ULONG32, Write) (THIS_
  117. REF(IHXBuffer*) pBuf); 
  118. /* Flush out the data in case of buffered I/O
  119.  */
  120. STDMETHOD(Flush) (THIS);
  121. /*
  122.  * Return info about the data file such as permissions, time of creation
  123.  * size in bytes, etc.
  124.  */
  125. STDMETHOD(Stat) (THIS_
  126. struct stat* buffer);
  127. /* Delete File */
  128. STDMETHOD(Delete) (THIS);
  129. /* Return the file descriptor */
  130. STDMETHOD_(INT16, GetFd) (THIS);
  131. /* GetLastError returns the platform specific file error */
  132. STDMETHOD(GetLastError) (THIS);
  133. /* GetLastError returns the platform specific file error in
  134.  * string form.
  135.  */
  136. STDMETHOD_(void, GetLastError) (THIS_
  137. REF(IHXBuffer*) err);
  138. /*
  139.  *  IHXAsyncDataFile
  140.  */
  141. STDMETHOD(SetReceiver) (THIS_
  142. IHXCallback* pCallback);
  143. STDMETHOD(SeekAsync) (THIS_
  144. REF(HX_RESULT) status, 
  145. ULONG32 offset, UINT16 fromWhere);
  146. STDMETHOD(ReadAsync) (THIS_
  147. REF(ULONG32) ulReadSize,
  148. REF(IHXBuffer*) pBuf, 
  149. ULONG32 count);
  150. STDMETHOD(WriteAsync) (THIS_
  151. REF(ULONG32) ulWrittenSize,
  152. REF(IHXBuffer*) pBuf);
  153. /*
  154.  *  Custom Public methods
  155.  */
  156. void Bind (IHXBuffer* pFileNameBuffer);
  157. BOOL GetTemporaryFileName (const char *tag, char* filename, UINT32 ulBufLen);
  158. /*
  159.  *  IUnknown methods
  160.  */
  161. STDMETHOD(QueryInterface) (THIS_
  162. REFIID riid,
  163. void** ppvObj);
  164. STDMETHOD_(ULONG32, AddRef) (THIS);
  165. STDMETHOD_(ULONG32, Release) (THIS);
  166. private:
  167. /*
  168.  *  Destructor
  169.  */
  170. ~CSymbIHXDataFile(void);
  171. /*
  172.  *  Private Methods
  173.  */
  174. HX_RESULT _Create(UINT16 uOpenMode, BOOL bCreateFile);
  175. inline TUint TranslateOpenMode(UINT16 uOpenMode);
  176. inline TSeek TranslateSeekMode(UINT16 fromWhere);
  177. inline BOOL GetSession(void);
  178. IHXBuffer* m_pFileName;
  179. IHXSymbFileSessionManager* m_pSessionManager;
  180. RFs m_symbSession;
  181. BOOL m_bHaveSession;
  182. RFile m_symbFile;
  183. BOOL m_bOpen;
  184. TInt m_symbLastError;
  185. LONG32 m_lRefCount;
  186. PRIVATE_DESTRUCTORS_ARE_NOT_A_CRIME
  187. };
  188. #endif // _SYMBIHXDATAF_H_