开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 通讯/手机编程 > Symbian > 查看源码
hxfiles.h
资源名称：helix.src.0812.rar　[点击查看]
上传用户：zhongxx05
上传日期：2007-06-06
资源大小：33641k
文件大小：70k
源码类别：

Symbian

开发平台：

C/C++

hxfiles.h：源码内容
  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 ***** */ 
  36. #ifndef _HXFILES_H_
  37. #define _HXFILES_H_
  39. /*
  40.  * Forward declarations of some interfaces defined here-in.
  41.  */
  42. typedef _INTERFACE IHXFileObject IHXFileObject;
  43. typedef _INTERFACE IHXFileObjectExt IHXFileObjectExt;
  44. typedef _INTERFACE IHXFileResponse IHXFileResponse;
  45. typedef _INTERFACE IHXFileSystemObject IHXFileSystemObject;
  46. typedef _INTERFACE IHXFileStat IHXFileStat;
  47. typedef _INTERFACE IHXFileStatResponse IHXFileStatResponse;
  49. typedef _INTERFACE IHXFileSystemManager IHXFileSystemManager;
  50. typedef _INTERFACE IHXFileSystemManagerResponse IHXFileSystemManagerResponse;
  51. typedef _INTERFACE IHXFileExists IHXFileExists;
  52. typedef _INTERFACE IHXFileExistsResponse IHXFileExistsResponse;
  53. typedef _INTERFACE IHXFileMimeMapper IHXFileMimeMapper;
  54. typedef _INTERFACE IHXFileMimeMapperResponse IHXFileMimeMapperResponse;
  55. typedef _INTERFACE IHXBroadcastMapper IHXBroadcastMapper;
  56. typedef _INTERFACE IHXBroadcastMapperResponse IHXBroadcastMapperResponse;
  57. typedef _INTERFACE IHXGetFileFromSamePoolResponse IHXGetFileFromSamePoolResponse;
  58. typedef _INTERFACE IHXBuffer IHXBuffer;
  59. typedef _INTERFACE IHXPacket IHXPacket;
  60. typedef _INTERFACE IHXValues IHXValues;
  61. typedef _INTERFACE IHXMetaCreation IHXMetaCreation;
  63. typedef _INTERFACE IHXAuthenticator               IHXAuthenticator;
  64. typedef _INTERFACE IHXRequest                     IHXRequest;
  65. typedef _INTERFACE IHXFileRename                  IHXFileRename;
  66. typedef _INTERFACE IHXFileMove IHXFileMove;
  67. typedef _INTERFACE IHXDirHandler IHXDirHandler;
  68. typedef _INTERFACE IHXDirHandlerResponse IHXDirHandlerResponse;
  69. typedef _INTERFACE IHXFileRemove                  IHXFileRemove;
  70. // $Private:
  71. typedef _INTERFACE IHXFastFileFactory             IHXFastFileFactory;
  72. typedef _INTERFACE IHXHTTPPostObject IHXHTTPPostObject;
  73. typedef _INTERFACE IHXHTTPPostResponse IHXHTTPPostResponse;
  74. typedef _INTERFACE IHXHTTPRedirect IHXHTTPRedirect;
  75. typedef _INTERFACE IHXHTTPRedirectResponse IHXHTTPRedirectResponse;
  76. typedef _INTERFACE IHXRM2Converter2               IHXRM2Converter2;
  77. typedef _INTERFACE IHXRM2Converter2Response       IHXRM2Converter2Response;
  78. typedef _INTERFACE IHXPoolPathAdjustment IHXPoolPathAdjustment;
  79. typedef _INTERFACE IHXPostDataHandler IHXPostDataHandler;
  80. // $EndPrivate.
  83. /****************************************************************************
  84.  *  Defines:
  85.  * HX_FILE_XXXX
  86.  *  Purpose:
  87.  * Flags for opening file objects
  88.  */
  89. #define HX_FILE_READ 1
  90. #define HX_FILE_WRITE 2
  91. #define HX_FILE_BINARY 4
  92. #define HX_FILE_NOTRUNC 8
  93. #define HX_FILE_NOPAC 16
  95. /****************************************************************************
  96.  *  Defines:
  97.  * HX_FILEADVISE_XXXX
  98.  *  Purpose:
  99.  * Flags for file object Advise method
  100.  */
  101. #define HX_FILEADVISE_RANDOMACCESS 1
  102. #define HX_FILEADVISE_SYNCACCESS 2
  103. #define HX_FILEADVISE_ASYNCACCESS 3
  104. #define HX_FILEADVISE_RANDOMACCESSONLY  4
  105. #define HX_FILEADVISE_ANYACCESS         5
  107. /****************************************************************************
  108.  *  Defines:
  109.  * HX_FILERESPONSEADVISE_XXXX
  110.  *  Purpose:
  111.  * Flags for file response Advise method
  112.  */
  113. #define HX_FILERESPONSEADVISE_REQUIREFULLREAD 1
  116. #if defined(_UNIX) || defined(_WINDOWS)
  117. #include "hlxclib/sys/stat.h"
  118. /*
  119.  * This is a subset of standard stat()/fstat() values that both Unix and
  120.  * Windows support (or at least define).
  121.  *
  122.  * These flags are returned from IHXFileStatResponse::StatDone() in the
  123.  * ulMode argument.
  124.  */
  125. #define HX_S_IFMT   S_IFMT
  126. #define HX_S_IFDIR  S_IFDIR
  127. #define HX_S_IFCHR  S_IFCHR
  128. #define HX_S_IFIFO  S_IFIFO
  129. #define HX_S_IFREG  S_IFREG
  130. #else
  131. /* Macintosh */
  132. #define HX_S_IFMT   0170000
  133. #define HX_S_IFDIR  0040000
  134. #define HX_S_IFCHR  0020000
  135. #define HX_S_IFIFO  0010000
  136. #define HX_S_IFREG  0100000
  137. #endif
  140. /****************************************************************************
  141.  * 
  142.  *  Interface:
  143.  * 
  144.  * IHXFileObject
  145.  * 
  146.  *  Purpose:
  147.  * 
  148.  * Object that exports file control API
  149.  * 
  150.  *  IID_IHXFileObject:
  151.  * 
  152.  * {00000200-0901-11d1-8B06-00A024406D59}
  153.  * 
  154.  */
  155. DEFINE_GUID(IID_IHXFileObject, 0x00000200, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  156. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  158. #undef  INTERFACE
  159. #define INTERFACE   IHXFileObject
  161. DECLARE_INTERFACE_(IHXFileObject, IUnknown)
  162. {
  163.     /*
  164.      * IUnknown methods
  165.      */
  166.     STDMETHOD(QueryInterface) (THIS_
  167. REFIID riid,
  168. void** ppvObj) PURE;
  170.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  172.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  174.     /*
  175.      * IHXFileObject methods
  176.      */
  178.     /************************************************************************
  179.      * Method:
  180.      *     IHXFileObject::Init
  181.      * Purpose:
  182.      *     Associates a file object with the file response object it should
  183.      *     notify of operation completness. This method should also check
  184.      *     for validity of the object (for example by opening it if it is
  185.      *     a local file).
  186.      */
  187.     STDMETHOD(Init) (THIS_
  188. ULONG32     /*IN*/  ulFlags,
  189. IHXFileResponse*   /*IN*/  pFileResponse) PURE;
  191.     /************************************************************************
  192.      * Method:
  193.      *     IHXFileObject::GetFilename
  194.      * Purpose:
  195.      *     Returns the filename (without any path information) associated
  196.      *     with a file object.
  197.      *
  198.      *     Note: The returned pointer's lifetime expires as soon as the
  199.      *     caller returns from a function which was called from the RMA
  200.      *     core (i.e. when you return control to the RMA core)
  201.      *
  202.      */
  203.     STDMETHOD(GetFilename) (THIS_
  204. REF(const char*)    /*OUT*/  pFilename) PURE;
  206.     /************************************************************************
  207.      * Method:
  208.      *     IHXFileObject::Close
  209.      * Purpose:
  210.      *     Closes the file resource and releases all resources associated
  211.      *     with the object.
  212.      */
  213.     STDMETHOD(Close) (THIS) PURE;
  215.     /************************************************************************
  216.      * Method:
  217.      *     IHXFileObject::Read
  218.      * Purpose:
  219.      *     Reads a buffer of data of the specified length from the file
  220.      *     and asynchronously returns it to the caller via the 
  221.      *     IHXFileResponse interface passed in to Init.
  222.      */
  223.     STDMETHOD(Read) (THIS_
  224. ULONG32 ulCount) PURE;
  226.     /************************************************************************
  227.      * Method:
  228.      *     IHXFileObject::Write
  229.      * Purpose:
  230.      *     Writes a buffer of data to the file and asynchronously notifies
  231.      *     the caller via the IHXFileResponse interface passed in to Init,
  232.      *     of the completeness of the operation.
  233.      */
  234.     STDMETHOD(Write) (THIS_
  235. IHXBuffer* pBuffer) PURE;
  237.     /************************************************************************
  238.      * Method:
  239.      *     IHXFileObject::Seek
  240.      * Purpose:
  241.      *     Seeks to an offset in the file and asynchronously notifies
  242.      *     the caller via the IHXFileResponse interface passed in to Init,
  243.      *     of the completeness of the operation.
  244.      *     If the bRelative flag is TRUE, it is a relative seek; else
  245.      *     an absolute seek.
  246.      */
  247.     STDMETHOD(Seek) (THIS_
  248. ULONG32 ulOffset,
  249. BOOL bRelative) PURE;    
  251.     /************************************************************************
  252.      * Method:
  253.      *     IHXFileObject::Advise
  254.      * Purpose:
  255.      *      To pass information to the File Object advising it about usage
  256.      *     heuristics.
  257.      */
  258.     STDMETHOD(Advise) (THIS_
  259. ULONG32 ulInfo) PURE;
  260. };
  263. /****************************************************************************
  264.  *
  265.  *  Interface:
  266.  *
  267.  *  IHXFileObjectExt
  268.  *
  269.  *  Purpose:
  270.  *
  271.  *  Object that exports file control API
  272.  *
  273.  *  IID_IHXFileObjectExt:
  274.  *
  275.  *  {96DD5EB5-7EFD-4084-95CD-4D192A9036AF}
  276.  *
  277.  */
  278.  DEFINE_GUID(IID_IHXFileObjectExt, 0x96dd5eb5, 0x7efd, 0x4084, 0x95, 0xcd, 0x4d,
  279.                        0x19, 0x2a, 0x90, 0x36, 0xaf);
  281. #undef  INTERFACE
  282. #define INTERFACE   IHXFileObjectExt
  284. DECLARE_INTERFACE_(IHXFileObjectExt, IUnknown)
  285. {
  286.     /*
  287.      *  IUnknown methods
  288.      */
  289.     STDMETHOD(QueryInterface)   (THIS_
  290.                 REFIID riid,
  291.                 void** ppvObj) PURE;
  293.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  295.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  297.     /************************************************************************
  298.      * Method:
  299.      *     IHXFileObjectExt::GetFullFilename
  300.      * Purpose:
  301.      *     Returns the filename, with path information, associated
  302.      *     with a file object.
  303.      *
  304.      *     Note: The returned pointer's lifetime expires as soon as the
  305.      *     caller returns from a function which was called from the RMA
  306.      *     core (i.e. when you return control to the RMA core)
  307.      *
  308.      */
  309.     STDMETHOD(GetFullFilename) (THIS_
  310.                                REF(IHXBuffer*)  /*OUT*/  pFullFilename) PURE;
  311. };
  314. /****************************************************************************
  315.  * 
  316.  *  Interface:
  317.  * 
  318.  * IHXFileResponse
  319.  * 
  320.  *  Purpose:
  321.  * 
  322.  * Object that exports file response API
  323.  * 
  324.  *  IID_IHXFileResponse:
  325.  * 
  326.  * {00000201-0901-11d1-8B06-00A024406D59}
  327.  * 
  328.  */
  329. DEFINE_GUID(IID_IHXFileResponse, 0x00000201, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  330. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  332. #undef  INTERFACE
  333. #define INTERFACE   IHXFileResponse
  335. DECLARE_INTERFACE_(IHXFileResponse, IUnknown)
  336. {
  337.     /*
  338.      * IUnknown methods
  339.      */
  340.     STDMETHOD(QueryInterface) (THIS_
  341. REFIID riid,
  342. void** ppvObj) PURE;
  344.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  346.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  348.     /*
  349.      * IHXFileResponse methods
  350.      */
  352.     /************************************************************************
  353.      * Method:
  354.      *     IHXFileResponse::InitDone
  355.      * Purpose:
  356.      *     Notification interface provided by users of the IHXFileObject
  357.      *     interface. This method is called by the IHXFileObject when the
  358.      *     initialization of the file is complete. If the file is not valid 
  359.      *     for the file system, the status HXR_FAILED should be 
  360.      *     returned.
  361.      */
  362.     STDMETHOD(InitDone) (THIS_
  363. HX_RESULT     status) PURE;
  365.     /************************************************************************
  366.      * Method:
  367.      *     IHXFileResponse::CloseDone
  368.      * Purpose:
  369.      *     Notification interface provided by users of the IHXFileObject
  370.      *     interface. This method is called by the IHXFileObject when the
  371.      *     close of the file is complete.
  372.      */
  373.     STDMETHOD(CloseDone) (THIS_
  374. HX_RESULT     status) PURE;
  376.     /************************************************************************
  377.      * Method:
  378.      *     IHXFileResponse::ReadDone
  379.      * Purpose:
  380.      *     Notification interface provided by users of the IHXFileObject
  381.      *     interface. This method is called by the IHXFileObject when the
  382.      *     last read from the file is complete and a buffer is available.
  383.      */
  384.     STDMETHOD(ReadDone) (THIS_ 
  385. HX_RESULT     status,
  386. IHXBuffer*     pBuffer) PURE;
  388.     /************************************************************************
  389.      * Method:
  390.      *     IHXFileResponse::WriteDone
  391.      * Purpose:
  392.      *     Notification interface provided by users of the IHXFileObject
  393.      *     interface. This method is called by the IHXFileObject when the
  394.      *     last write to the file is complete.
  395.      */
  396.     STDMETHOD(WriteDone) (THIS_ 
  397. HX_RESULT     status) PURE;
  399.     /************************************************************************
  400.      * Method:
  401.      *     IHXFileResponse::SeekDone
  402.      * Purpose:
  403.      *     Notification interface provided by users of the IHXFileObject
  404.      *     interface. This method is called by the IHXFileObject when the
  405.      *     last seek in the file is complete.
  406.      */
  407.     STDMETHOD(SeekDone) (THIS_ 
  408. HX_RESULT     status) PURE;
  409. };
  411. /****************************************************************************
  412.  * 
  413.  *  Interface:
  414.  * 
  415.  *      IHXAdvise
  416.  * 
  417.  *  Purpose:
  418.  * 
  419.  *      Allow IHXFileObject to query its IHXFileResponse interface
  420.  * 
  421.  *  IID_IHXAdvise:
  422.  * 
  423.  *      {43C3A3B8-8F76-4394-A4F8-07AA9091A0CA}
  424.  * 
  425.  */
  426. DEFINE_GUID(IID_IHXAdvise, 0x43c3a3b8, 0x8f76, 0x4394, 0xa4, 0xf8, 0x7, 
  427.                         0xaa, 0x90, 0x91, 0xa0, 0xca);
  429. #undef  INTERFACE
  430. #define INTERFACE   IHXAdvise
  432. DECLARE_INTERFACE_(IHXAdvise, IUnknown)
  433. {
  434.     /*
  435.      *  IUnknown methods
  436.      */
  437.     STDMETHOD(QueryInterface)           (THIS_
  438.                                         REFIID riid,
  439.                                         void** ppvObj) PURE;
  441.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  443.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  445.     /*
  446.      *  IHXAdvise methods
  447.      */
  449.     /************************************************************************
  450.      *  Method:
  451.      *      IHXAdvise::Advise
  452.      *  Purpose:
  453.      *      Allows IHXFileObject to query its IHXFileResponse about
  454.      *      usage heuristics. It should pass HX_FILERESPONSEADVISE_xxx
  455.      *      flags into this method.
  456.      */
  457.     STDMETHOD(Advise)   (THIS_ ULONG32 ulInfo) PURE;
  458. };
  461. /****************************************************************************
  462.  * 
  463.  *  Interface:
  464.  * 
  465.  * IHXFileSystemObject
  466.  * 
  467.  *  Purpose:
  468.  * 
  469.  * Object that allows a Controller to communicate with a specific
  470.  * File System plug-in session
  471.  * 
  472.  *  IID_IHXFileSystemObject:
  473.  * 
  474.  * {00000202-0901-11d1-8B06-00A024406D59}
  475.  * 
  476.  */
  477. DEFINE_GUID(IID_IHXFileSystemObject, 0x00000202, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  478. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  480. #undef  INTERFACE
  481. #define INTERFACE   IHXFileSystemObject
  483. DECLARE_INTERFACE_(IHXFileSystemObject, IUnknown)
  484. {
  485.     /*
  486.      * IUnknown methods
  487.      */
  488.     STDMETHOD(QueryInterface) (THIS_
  489. REFIID riid,
  490. void** ppvObj) PURE;
  492.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  494.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  496.     /*
  497.      * IHXFileSystemObject methods
  498.      */
  500.     /************************************************************************
  501.      * Method:
  502.      *     IHXFileSystemObject::GetFileSystemInfo
  503.      * Purpose:
  504.      *     Returns information vital to the instantiation of file system
  505.      *     plugin.
  506.      *
  507.      *     pShortName should be a short, human readable name in the form
  508.      *      of "company-fsname".  For example: pShortName = "pn-local".
  509.      */
  510.     STDMETHOD(GetFileSystemInfo)    (THIS_
  511.     REF(const char*) /*OUT*/ pShortName,
  512.     REF(const char*) /*OUT*/ pProtocol) PURE;
  514.     STDMETHOD(InitFileSystem) (THIS_
  515. IHXValues* pOptions) PURE;
  517.     STDMETHOD(CreateFile) (THIS_
  518. IUnknown**    /*OUT*/ ppFileObject) PURE;
  520.     /*
  521.      * The following method is deprecated and should return HXR_NOTIMPL
  522.      */
  524.     STDMETHOD(CreateDir) (THIS_
  525. IUnknown**   /*OUT*/ ppDirObject) PURE;
  527. };
  530. /****************************************************************************
  531.  * 
  532.  *  Interface:
  533.  * 
  534.  * IHXFileStat
  535.  * 
  536.  *  Purpose:
  537.  * 
  538.  *      Gets information about a specific File object
  539.  * 
  540.  *  IID_IHXFileStat:
  541.  *  
  542.  * {00000205-0901-11d1-8B06-00A024406D59}
  543.  * 
  544.  */
  545. DEFINE_GUID(IID_IHXFileStat, 0x00000205, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  546. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  548. #undef  INTERFACE
  549. #define INTERFACE   IHXFileStat
  551. DECLARE_INTERFACE_(IHXFileStat, IUnknown)
  552. {
  553.     /*
  554.      * IUnknown methods
  555.      */
  556.     STDMETHOD(QueryInterface)   (THIS_
  557.                                 REFIID riid,
  558.                                 void** ppvObj) PURE;
  560.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  562.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  564.     /*
  565.      * IHXFileStat methods
  566.      */
  568.     STDMETHOD(Stat) (THIS_
  569. IHXFileStatResponse* pFileStatResponse
  570. ) PURE;
  571. };
  574. /****************************************************************************
  575.  * 
  576.  *  Interface:
  577.  * 
  578.  * IHXFileStatResponse
  579.  * 
  580.  *  Purpose:
  581.  * 
  582.  *      Returns information about a specific File object
  583.  * 
  584.  *  IID_IHXFileStatResponse:
  585.  *  
  586.  * {00000206-0901-11d1-8B06-00A024406D59}
  587.  * 
  588.  */
  589. DEFINE_GUID(IID_IHXFileStatResponse, 0x00000206, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  590. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  592. #undef  INTERFACE
  593. #define INTERFACE   IHXFileStatResponse
  595. DECLARE_INTERFACE_(IHXFileStatResponse, IUnknown)
  596. {
  597.     /*
  598.      * IUnknown methods
  599.      */
  600.     STDMETHOD(QueryInterface)   (THIS_
  601.                                 REFIID riid,
  602.                                 void** ppvObj) PURE;
  604.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  606.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  608.     /*
  609.      * IHXFileStat methods
  610.      */
  612.     STDMETHOD(StatDone) (THIS_
  613.  HX_RESULT status,
  614.  UINT32 ulSize,
  615.  UINT32 ulCreationTime,
  616.  UINT32 ulAccessTime,
  617.  UINT32 ulModificationTime,
  618.  UINT32 ulMode) PURE;
  619. };
  621. /****************************************************************************
  622.  * 
  623.  *  Interface:
  624.  * 
  625.  * IHXFileSystemManager
  626.  * 
  627.  *  Purpose:
  628.  * 
  629.  *      Gives out File Objects based on URLs
  630.  * 
  631.  *  IID_IHXFileSystemManager:
  632.  *  
  633.  * {00000207-0901-11d1-8B06-00A024406D59}
  634.  * 
  635.  */
  636. DEFINE_GUID(IID_IHXFileSystemManager, 0x00000207, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  637. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  639. #undef  INTERFACE
  640. #define INTERFACE   IHXFileSystemManager
  642. #define CLSID_IHXFileSystemManager IID_IHXFileSystemManager
  644. DECLARE_INTERFACE_(IHXFileSystemManager, IUnknown)
  645. {
  646.     /*
  647.      * IUnknown methods
  648.      */
  649.     STDMETHOD(QueryInterface)   (THIS_
  650.                                 REFIID riid,
  651.                                 void** ppvObj) PURE;
  653.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  655.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  657.     /*
  658.      * IHXFileSystemManager methods
  659.      */
  661.     STDMETHOD(Init) (THIS_
  662.     IHXFileSystemManagerResponse* /*IN*/  pFileManagerResponse
  663.     ) PURE;
  665.     /* GetFileObject attempts to locate an existing file via the DoesExist
  666.      * method in each file system's objects, and returns that object through
  667.      * FSManagerResponse->FileObjectReady
  668.      */
  669.     STDMETHOD(GetFileObject) (THIS_
  670.  IHXRequest* pRequest,
  671.  IHXAuthenticator* pAuthenticator) PURE;
  673.     /* GetNewFileObject is similar to GetFileObject except that no DoesExist
  674.      * checks are done.  The first file system that matches the mount point
  675.      * or protocol for the path in the request object creates the file
  676.      * which is then returned through FileObjectReady.  This is especially
  677.      * useful for those who wish to open a brand new file for writing.
  678.      */
  679.     STDMETHOD(GetNewFileObject) (THIS_
  680.  IHXRequest* pRequest,
  681.  IHXAuthenticator* pAuthenticator) PURE;
  683.     STDMETHOD(GetRelativeFileObject) (THIS_
  684.       IUnknown* pOriginalObject,
  685.       const char* pPath) PURE;
  687.     /*
  688.      * The following method is deprecated and should return HXR_NOTIMPL
  689.      */
  691.     STDMETHOD(GetDirObjectFromURL) (THIS_
  692.                                         const char* pURL) PURE;
  693. };
  696. /****************************************************************************
  697.  * 
  698.  *  Interface:
  699.  * 
  700.  * IHXFileSystemManagerResponse
  701.  * 
  702.  *  Purpose:
  703.  * 
  704.  *      Gives out File System objects based on URLs
  705.  * 
  706.  *  IID_IHXFileSystemManagerResponse:
  707.  *  
  708.  * {00000208-0901-11d1-8B06-00A024406D59}
  709.  * 
  710.  */
  711. DEFINE_GUID(IID_IHXFileSystemManagerResponse, 0x00000208, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  712. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  714. #undef  INTERFACE
  715. #define INTERFACE   IHXFileSystemManagerResponse
  717. DECLARE_INTERFACE_(IHXFileSystemManagerResponse, IUnknown)
  718. {
  719.     /*
  720.      * IUnknown methods
  721.      */
  722.     STDMETHOD(QueryInterface)   (THIS_
  723.                                 REFIID riid,
  724.                                 void** ppvObj) PURE;
  726.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  728.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  730.     /*
  731.      * IHXFileSystemManagerResponse methods
  732.      */
  734.     /************************************************************************
  735.      * Method:
  736.      * IHXFileSystemManagerResponse::InitDone
  737.      * Purpose:
  738.      */
  739.     STDMETHOD(InitDone)     (THIS_
  740.     HX_RESULT     status) PURE;
  742.     STDMETHOD(FileObjectReady) (THIS_
  743. HX_RESULT status,
  744.                                 IUnknown* pObject) PURE;
  746.     /*
  747.      * The following method is deprecated and should return HXR_NOTIMPL
  748.      */
  750.     STDMETHOD(DirObjectReady) (THIS_
  751. HX_RESULT status,
  752.                                 IUnknown* pDirObject) PURE;
  753. };
  756. /****************************************************************************
  757.  * 
  758.  *  Interface:
  759.  * 
  760.  * IHXFileExists
  761.  * 
  762.  *  Purpose:
  763.  * 
  764.  * Checks for the existense of a file.  Must be implemented.
  765.  * 
  766.  *  IID_IHXFileExists:
  767.  * 
  768.  * {00000209-0901-11d1-8B06-00A024406D59}
  769.  * 
  770.  */
  771. DEFINE_GUID(IID_IHXFileExists, 0x00000209, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  772. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  774. #undef  INTERFACE
  775. #define INTERFACE   IHXFileExists
  777. DECLARE_INTERFACE_(IHXFileExists, IUnknown)
  778. {
  779.     /*
  780.      * IUnknown methods
  781.      */
  782.     STDMETHOD(QueryInterface) (THIS_
  783. REFIID riid,
  784. void** ppvObj) PURE;
  786.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  788.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  790.     /*
  791.      * IHXFileExists methods
  792.      */
  794.     /************************************************************************
  795.      * Method:
  796.      *     IHXFileExists::DoesExist
  797.      * Purpose:
  798.      */
  799.     STDMETHOD(DoesExist) (THIS_
  800. const char* /*IN*/  pPath, 
  801. IHXFileExistsResponse* /*IN*/  pFileResponse) PURE;
  802. };
  805. /****************************************************************************
  806.  * 
  807.  *  Interface:
  808.  * 
  809.  * IHXFileExistsResponse
  810.  * 
  811.  *  Purpose:
  812.  * 
  813.  * Response interface for IHXFileExists.  Must be implemented.
  814.  * 
  815.  *  IID_IHXFileExistsResponse:
  816.  * 
  817.  * {0000020A-0901-11d1-8B06-00A024406D59}
  818.  * 
  819.  */
  820. DEFINE_GUID(IID_IHXFileExistsResponse, 0x0000020a, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  821. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  823. #undef  INTERFACE
  824. #define INTERFACE   IHXFileExists
  826. DECLARE_INTERFACE_(IHXFileExistsResponse, IUnknown)
  827. {
  828.     /*
  829.      * IUnknown methods
  830.      */
  831.     STDMETHOD(QueryInterface) (THIS_
  832. REFIID riid,
  833. void** ppvObj) PURE;
  835.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  837.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  839.     /*
  840.      * IHXFileExistsResponse methods
  841.      */
  843.     STDMETHOD(DoesExistDone) (THIS_
  844.       BOOL bExist) PURE;
  845. };
  848. /****************************************************************************
  849.  * 
  850.  *  Interface:
  851.  * 
  852.  * IHXFileMimeMapper
  853.  * 
  854.  *  Purpose:
  855.  * 
  856.  * Allows you to specify a mime type for a specific file.
  857.  * Optional interface.
  858.  * 
  859.  *  IID_IHXFileMimeMapper:
  860.  * 
  861.  * {0000020B-0901-11d1-8B06-00A024406D59}
  862.  * 
  863.  */
  864. DEFINE_GUID(IID_IHXFileMimeMapper, 0x0000020b, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  865. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  867. #undef  INTERFACE
  868. #define INTERFACE   IHXFileMimeMapper
  870. DECLARE_INTERFACE_(IHXFileMimeMapper, IUnknown)
  871. {
  872.     /*
  873.      * IUnknown methods
  874.      */
  875.     STDMETHOD(QueryInterface) (THIS_
  876. REFIID riid,
  877. void** ppvObj) PURE;
  879.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  881.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  883.     /*
  884.      * IHXFileMimeMapper methods
  885.      */
  887.     /************************************************************************
  888.      * Method:
  889.      *     IHXFileMimeMapper::FindMimeType
  890.      * Purpose:
  891.      */
  892.     STDMETHOD(FindMimeType) (THIS_
  893.     const char*     /*IN*/  pURL, 
  894.     IHXFileMimeMapperResponse* /*IN*/  pMimeMapperResponse
  895.     ) PURE;
  896. };
  899. /****************************************************************************
  900.  * 
  901.  *  Interface:
  902.  * 
  903.  * IHXFileMimeMapperResponse
  904.  * 
  905.  *  Purpose:
  906.  * 
  907.  * Response interface for IHXFileMimeMapper.
  908.  * Optional interface.
  909.  * 
  910.  *  IID_IHXFileMimeMapperResponse:
  911.  * 
  912.  * {0000020C-0901-11d1-8B06-00A024406D59}
  913.  * 
  914.  */
  915. DEFINE_GUID(IID_IHXFileMimeMapperResponse, 0x0000020c, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  916. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  918. #undef  INTERFACE
  919. #define INTERFACE   IHXFileMimeMapperResponse
  921. DECLARE_INTERFACE_(IHXFileMimeMapperResponse, IUnknown)
  922. {
  923.     /*
  924.      * IUnknown methods
  925.      */
  926.     STDMETHOD(QueryInterface) (THIS_
  927. REFIID riid,
  928. void** ppvObj) PURE;
  930.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  932.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  934.     /*
  935.      * IHXFileMimeMapperResponse methods
  936.      */
  938.     /************************************************************************
  939.      * Method:
  940.      *     IHXFileMimeMapperResponse::MimeTypeFound
  941.      * Purpose:
  942.      *     Notification interface provided by users of the IHXFileMimeMapper
  943.      *     interface. This method is called by the IHXFileObject when the
  944.      *     initialization of the file is complete, and the Mime type is
  945.      *     available for the request file. If the file is not valid for the
  946.      *     file system, the status HXR_FAILED should be returned,
  947.      *     with a mime type of NULL. If the file is valid but the mime type
  948.      *     is unknown, then the status HXR_OK should be returned with
  949.      *     a mime type of NULL.
  950.      *     
  951.      */
  952.     STDMETHOD(MimeTypeFound) (THIS_
  953.       HX_RESULT status,
  954.       const char* pMimeType) PURE;
  955. };
  958. /****************************************************************************
  959.  * 
  960.  *  Interface:
  961.  * 
  962.  * IHXBroadcastMapper
  963.  * 
  964.  *  Purpose:
  965.  * 
  966.  * Associates a file with a broadcast format plugin.
  967.  * Implementation only required by broadcast plugin file systems.
  968.  * 
  969.  *  IID_IHXBroadcastMapper:
  970.  * 
  971.  * {0000020D-0901-11d1-8B06-00A024406D59}
  972.  * 
  973.  */
  974. DEFINE_GUID(IID_IHXBroadcastMapper, 0x0000020d, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  975. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  977. #undef  INTERFACE
  978. #define INTERFACE   IHXBroadcastMapper
  980. DECLARE_INTERFACE_(IHXBroadcastMapper, IUnknown)
  981. {
  982.     /*
  983.      * IUnknown methods
  984.      */
  985.     STDMETHOD(QueryInterface) (THIS_
  986. REFIID riid,
  987. void** ppvObj) PURE;
  989.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  991.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  993.     /*
  994.      * IHXBroadcastMapper methods
  995.      */
  997.     /************************************************************************
  998.      * Method:
  999.      *     IHXBroadcastMapper::FindBroadcastType
  1000.      * Purpose:
  1001.      */
  1002.     STDMETHOD(FindBroadcastType) (THIS_
  1003. const char*      /*IN*/  pURL, 
  1004. IHXBroadcastMapperResponse* /*IN*/  pBroadcastMapperResponse) PURE;
  1005. };
  1008. /****************************************************************************
  1009.  * 
  1010.  *  Interface:
  1011.  * 
  1012.  * IHXBroadcastMapperResponse
  1013.  * 
  1014.  *  Purpose:
  1015.  * 
  1016.  * Response interface for IHXBroadcastMapper.
  1017.  * Implementation only required by broadcast plugin file systems.
  1018.  * 
  1019.  *  IID_IHXBroadcastMapperResponse:
  1020.  * 
  1021.  * {0000020E-0901-11d1-8B06-00A024406D59}
  1022.  * 
  1023.  */
  1024. DEFINE_GUID(IID_IHXBroadcastMapperResponse, 0x0000020e, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1025. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1027. #undef  INTERFACE
  1028. #define INTERFACE   IHXBroadcastMapperResponse
  1030. DECLARE_INTERFACE_(IHXBroadcastMapperResponse, IUnknown)
  1031. {
  1032.     /*
  1033.      * IUnknown methods
  1034.      */
  1035.     STDMETHOD(QueryInterface) (THIS_
  1036. REFIID riid,
  1037. void** ppvObj) PURE;
  1039.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1041.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1043.     /*
  1044.      * IHXBroadcastMapperResponse methods
  1045.      */
  1047.     /************************************************************************
  1048.      * Method:
  1049.      *     IHXBroadcastMapperResponse::BroadcastTypeFound
  1050.      * Purpose:
  1051.      *     Notification interface provided by users of the IHXBroadcastMapper
  1052.      *     interface. This method is called by the File Object when the
  1053.      *     initialization of the file is complete, and the broadcast type is
  1054.      *     available for the request file. If the file is not valid for the
  1055.      *     file system, the status HXR_FAILED should be returned,
  1056.      *     with the broadcast type set to NULL.
  1057.      *     
  1058.      */
  1059.     STDMETHOD(BroadcastTypeFound) (THIS_
  1060.   HX_RESULT status,
  1061.   const char* pBroadcastType) PURE;
  1062. };
  1065. /****************************************************************************
  1066.  * 
  1067.  *  Interface:
  1068.  * 
  1069.  * IHXGetFileFromSamePool
  1070.  * 
  1071.  *  Purpose:
  1072.  * 
  1073.  *      Gives out File Objects based on filenames and relative "paths"
  1074.  * 
  1075.  *  IID_IHXGetFileFromSamePool:
  1076.  *  
  1077.  * {0000020f-0901-11d1-8B06-00A024406D59}
  1078.  * 
  1079.  */
  1080. DEFINE_GUID(IID_IHXGetFileFromSamePool, 0x0000020f, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1081. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1082. #undef  INTERFACE
  1083. #define INTERFACE   IHXGetFileFromSamePool
  1085. #define CLSID_IHXGetFileFromSamePool IID_IHXGetFileFromSamePool
  1087. DECLARE_INTERFACE_(IHXGetFileFromSamePool, IUnknown)
  1088. {
  1089.     /*
  1090.      * IUnknown methods
  1091.      */
  1092.     STDMETHOD(QueryInterface)   (THIS_
  1093.                                 REFIID riid,
  1094.                                 void** ppvObj) PURE;
  1096.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1098.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1101.     /*
  1102.      * IHXGetFileFromSamePool method
  1103.      */
  1104.     /************************************************************************
  1105.      * Method:
  1106.      *     IHXGetFileFromSamePool::GetFileObjectFromPool
  1107.      * Purpose:
  1108.      *      To get another FileObject from the same pool. 
  1109.      */
  1110.     STDMETHOD(GetFileObjectFromPool) (THIS_
  1111.  IHXGetFileFromSamePoolResponse*) PURE;
  1112. };
  1115. /****************************************************************************
  1116.  * 
  1117.  *  Interface:
  1118.  * 
  1119.  * IHXGetFileFromSamePoolResponse
  1120.  * 
  1121.  *  Purpose:
  1122.  * 
  1123.  *      Gives out File Objects based on filenames and relative "paths"
  1124.  * 
  1125.  *  IID_IHXGetFileFromSamePoolResponse:
  1126.  *  
  1127.  * {00000210-0901-11d1-8B06-00A024406D59}
  1128.  * 
  1129.  */
  1130. DEFINE_GUID(IID_IHXGetFileFromSamePoolResponse, 0x00000210, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1131. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1132. #undef  INTERFACE
  1133. #define INTERFACE   IHXGetFileFromSamePoolResponse
  1135. #define CLSID_IHXGetFileFromSamePoolResponse IID_IHXGetFileFromSamePoolResponse
  1137. DECLARE_INTERFACE_(IHXGetFileFromSamePoolResponse, IUnknown)
  1138. {
  1139.     /*
  1140.      * IUnknown methods
  1141.      */
  1142.     STDMETHOD(QueryInterface)   (THIS_
  1143.                                 REFIID riid,
  1144.                                 void** ppvObj) PURE;
  1146.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1148.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1150.     /*
  1151.      * IHXGetFileFromSamePoolResponse method
  1152.      */
  1153.     /************************************************************************
  1154.      * Method:
  1155.      *     IHXGetFileFromSamePoolResponse::FileObjectReady
  1156.      * Purpose:
  1157.      *      To return another FileObject from the same pool. 
  1158.      */
  1159.     STDMETHOD(FileObjectReady) (THIS_
  1160. HX_RESULT status,
  1161. IUnknown* ppUnknown) PURE;
  1162. };
  1165. /****************************************************************************
  1166.  * 
  1167.  *  Interface:
  1168.  * 
  1169.  * IHXFileAuthenticator
  1170.  * 
  1171.  *  Purpose:
  1172.  * 
  1173.  *      Set and Get a file object's authenticator object.
  1174.  * 
  1175.  *  IID_IHXFileAuthenticator:
  1176.  *  
  1177.  * {00000211-0901-11d1-8B06-00A024406D59}
  1178.  * 
  1179.  */
  1180. DEFINE_GUID(IID_IHXFileAuthenticator, 0x00000211, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1181. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1182. #undef  INTERFACE
  1183. #define INTERFACE   IHXFileAuthenticator
  1185. #define CLSID_IHXFileAuthenticator IID_IHXFileAuthenticator
  1187. DECLARE_INTERFACE_(IHXFileAuthenticator, IUnknown)
  1188. {
  1189.     /*
  1190.      * IUnknown methods
  1191.      */
  1192.     STDMETHOD(QueryInterface)   (THIS_
  1193.                                 REFIID riid,
  1194.                                 void** ppvObj) PURE;
  1196.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1198.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1200.     /*
  1201.      * IHXFileAuthenticator methods
  1202.      */
  1203.     STDMETHOD(SetAuthenticator) (THIS_
  1204.  IHXAuthenticator* pAuthenticator) PURE;
  1205.     
  1206.     STDMETHOD(GetAuthenticator) (THIS_
  1207.  REF(IHXAuthenticator*) pAuthenticator) PURE;
  1208. };
  1211. /****************************************************************************
  1212.  * 
  1213.  *  Interface:
  1214.  * 
  1215.  * IHXRequestHandler
  1216.  * 
  1217.  *  Purpose:
  1218.  * 
  1219.  *      Object to manage IHXRequest objects
  1220.  * 
  1221.  *  IID_IHXRequestHandler:
  1222.  *  
  1223.  * {00000212-0901-11d1-8B06-00A024406D59}
  1224.  * 
  1225.  */
  1226. DEFINE_GUID(IID_IHXRequestHandler, 0x00000212, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1227. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1228. #undef  INTERFACE
  1229. #define INTERFACE   IHXRequestHandler
  1231. #define CLSID_IHXRequestHandler IID_IHXRequestHandler
  1233. DECLARE_INTERFACE_(IHXRequestHandler, IUnknown)
  1234. {
  1235.     /*
  1236.      * IUnknown methods
  1237.      */
  1239.     STDMETHOD(QueryInterface)   (THIS_
  1240.                                 REFIID riid,
  1241.                                 void** ppvObj) PURE;
  1243.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1245.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1247.     /************************************************************************
  1248.      * Method:
  1249.      *     IHXRequestHandler::SetRequest
  1250.      * Purpose:
  1251.      *     Associates an IHXRequest with an object
  1252.      */
  1253.     STDMETHOD(SetRequest)   (THIS_
  1254.     IHXRequest*        /*IN*/  pRequest) PURE;
  1256.     /************************************************************************
  1257.      * Method:
  1258.      *     IHXRequestHandler::GetRequest
  1259.      * Purpose:
  1260.      *     Gets the IHXRequest object associated with an object
  1261.      */
  1262.     STDMETHOD(GetRequest)   (THIS_
  1263.     REF(IHXRequest*)        /*OUT*/  pRequest) PURE;
  1265. };
  1268. /****************************************************************************
  1269.  * 
  1270.  *  Interface:
  1271.  * 
  1272.  * IHXRequestContext
  1273.  * 
  1274.  *  Purpose:
  1275.  * 
  1276.  *      Object to manage the context of the Request
  1277.  * 
  1278.  *  IID_IHXRequestContext:
  1279.  *  
  1280.  * {00000217-0901-11d1-8B06-00A024406D59}
  1281.  * 
  1282.  */
  1283. DEFINE_GUID(IID_IHXRequestContext, 0x00000217, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1284. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1285. #undef  INTERFACE
  1286. #define INTERFACE   IHXRequestContext
  1288. #define CLSID_IHXRequestContext IID_IHXRequestContext
  1290. DECLARE_INTERFACE_(IHXRequestContext, IUnknown)
  1291. {
  1292.     /*
  1293.      * IUnknown methods
  1294.      */
  1296.     STDMETHOD(QueryInterface)   (THIS_
  1297.                                 REFIID riid,
  1298.                                 void** ppvObj) PURE;
  1300.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1302.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1304.     /*
  1305.      * IHXRequestContext methods
  1306.      */
  1308.     /************************************************************************
  1309.      * Method:
  1310.      *     IHXRequestContext::SetUserContext
  1311.      * Purpose:
  1312.      *     Sets the Authenticated users Context.
  1313.      */
  1314.     STDMETHOD(SetUserContext)
  1315.     (
  1316. THIS_
  1317. IUnknown* pIUnknownNewContext
  1318.     ) PURE;
  1320.     /************************************************************************
  1321.      * Method:
  1322.      *     IHXRequestContext::GetUserContext
  1323.      * Purpose:
  1324.      *     Gets the Authenticated users Context.
  1325.      */
  1326.     STDMETHOD(GetUserContext)
  1327.     (
  1328. THIS_
  1329. REF(IUnknown*) pIUnknownCurrentContext
  1330.     ) PURE;
  1332.     /************************************************************************
  1333.      * Method:
  1334.      *     IHXRequestContext::SetRequester
  1335.      * Purpose:
  1336.      *     Sets the Object that made the request.
  1337.      */
  1338.     STDMETHOD(SetRequester)
  1339.     (
  1340. THIS_
  1341. IUnknown* pIUnknownNewRequester
  1342.     ) PURE;
  1344.     /************************************************************************
  1345.      * Method:
  1346.      *     IHXRequestContext::GetRequester
  1347.      * Purpose:
  1348.      *     Gets the Object that made the request.
  1349.      */
  1350.     STDMETHOD(GetRequester)
  1351.     (
  1352. THIS_
  1353. REF(IUnknown*) pIUnknownCurrentRequester
  1354.     ) PURE;
  1355. };
  1357. /****************************************************************************
  1358.  * 
  1359.  *  Interface:
  1360.  * 
  1361.  * IHXRequest
  1362.  * 
  1363.  *  Purpose:
  1364.  * 
  1365.  *      Object to manage the RFC822 headers sent by the client
  1366.  * 
  1367.  *  IID_IHXRequest:
  1368.  *  
  1369.  * {00000213-0901-11d1-8B06-00A024406D59}
  1370.  * 
  1371.  */
  1372. DEFINE_GUID(IID_IHXRequest, 0x00000213, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1373. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1374. #undef  INTERFACE
  1375. #define INTERFACE   IHXRequest
  1377. #define CLSID_IHXRequest IID_IHXRequest
  1379. DECLARE_INTERFACE_(IHXRequest, IUnknown)
  1380. {
  1381.     /*
  1382.      * IUnknown methods
  1383.      */
  1385.     STDMETHOD(QueryInterface)   (THIS_
  1386.                                 REFIID riid,
  1387.                                 void** ppvObj) PURE;
  1389.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1391.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1393.     /*
  1394.      * IHXRequest methods
  1395.      */
  1397.     /************************************************************************
  1398.      * Method:
  1399.      *     IHXRequest::SetRequestHeaders
  1400.      * Purpose:
  1401.      *     Sets the headers that will be sent in the RFC822 header section
  1402.      *      of the request message
  1403.      */
  1404.     STDMETHOD(SetRequestHeaders) (THIS_
  1405. IHXValues* pRequestHeaders) PURE;
  1406.     
  1407.     /************************************************************************
  1408.      * Method:
  1409.      *     IHXRequest::GetRequestHeaders
  1410.      * Purpose:
  1411.      *     Gets the headers that were sent in the RFC822 header section
  1412.      *     of the request message
  1413.      */
  1414.     STDMETHOD(GetRequestHeaders) (THIS_
  1415. REF(IHXValues*) pRequestHeaders) PURE;
  1417.     /************************************************************************
  1418.      * Method:
  1419.      *     IHXRequest::SetResponseHeaders
  1420.      * Purpose:
  1421.      *     Sets the headers that will be returned in the RFC822 header
  1422.      *     section of the response message
  1423.      */
  1424.     STDMETHOD(SetResponseHeaders) (THIS_
  1425. IHXValues* pResponseHeaders) PURE;
  1426.     
  1427.     /************************************************************************
  1428.      * Method:
  1429.      *     IHXRequest::GetResponseHeaders
  1430.      * Purpose:
  1431.      *     Gets the headers that were returned in the RFC822 header section
  1432.      *     of the response message
  1433.      */
  1434.     STDMETHOD(GetResponseHeaders) (THIS_
  1435. REF(IHXValues*) pResponseHeaders) PURE;
  1437.     /************************************************************************
  1438.      * Method:
  1439.      *     IHXRequest::SetURL
  1440.      * Purpose:
  1441.      *     Sets the fully qualified path associated with a file object.
  1442.      *     Note: On the server, this path does not include the file system
  1443.      *      mount point.
  1444.      */
  1445.     STDMETHOD(SetURL) (THIS_
  1446. const char* pURL) PURE;
  1448.     /************************************************************************
  1449.      * Method:
  1450.      *     IHXRequest::GetURL
  1451.      * Purpose:
  1452.      *     Returns the fully qualified path associated with a file object.
  1453.      *     Note: On the server, this path does not include the file system
  1454.      *      mount point.
  1455.      *
  1456.      *     Note: The returned pointer's lifetime expires as soon as the
  1457.      *     caller returns from a function which was called from the RMA
  1458.      *     core (i.e. when you return control to the RMA core)
  1459.      */
  1460.     STDMETHOD(GetURL) (THIS_
  1461. REF(const char*) pURL) PURE;
  1462. };
  1464. /****************************************************************************
  1465.  * 
  1466.  *  Interface:
  1467.  * 
  1468.  * IHXFileRename
  1469.  * 
  1470.  *  Purpose:
  1471.  * 
  1472.  *      Interface to allow renaming of files.  Query off of the File Object.
  1473.  * Not all filesystem plugins implement this feature.
  1474.  * 
  1475.  *  IID_IHXFileRename:
  1476.  *  
  1477.  * {00000214-0901-11d1-8B06-00A024406D59}
  1478.  * 
  1479.  */
  1480. DEFINE_GUID(IID_IHXFileRename, 0x00000214, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1481. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1482. #undef  INTERFACE
  1483. #define INTERFACE   IHXFileRename
  1485. DECLARE_INTERFACE_(IHXFileRename, IUnknown)
  1486. {
  1487.     /*
  1488.      * IUnknown methods
  1489.      */
  1491.     STDMETHOD(QueryInterface)   (THIS_
  1492.                                 REFIID riid,
  1493.                                 void** ppvObj) PURE;
  1495.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1497.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1499.     /*
  1500.      * IHXFileRename methods
  1501.      */
  1503.     /************************************************************************
  1504.      * Method:
  1505.      *     IHXFileRename::Rename
  1506.      * Purpose:
  1507.      *     Renames a file to a new name.
  1508.      */
  1509.     STDMETHOD(Rename) (THIS_
  1510. const char* pNewFileName) PURE;
  1511. };
  1514. /****************************************************************************
  1515.  * 
  1516.  *  Interface:
  1517.  * 
  1518.  * IHXFileMove
  1519.  * 
  1520.  *  Purpose:
  1521.  * 
  1522.  *      Interface to allow removing of files.  Query off of the File Object.
  1523.  * Not all filesystem plugins implement this feature.
  1524.  * 
  1525.  *  IID_IHXFileMove:
  1526.  *  
  1527.  * {23E72FB0-DE0E-11d5-AA9A-00010251B340}
  1528.  * 
  1529.  */
  1530. DEFINE_GUID(IID_IHXFileMove, 0x23e72fb0, 0xde0e, 0x11d5, 0xaa, 0x9a, 0x0, 
  1531. 0x1, 0x2, 0x51, 0xb3, 0x40);
  1533. #undef  INTERFACE
  1534. #define INTERFACE   IHXFileMove
  1536. DECLARE_INTERFACE_(IHXFileMove, IUnknown)
  1537. {
  1538.     /*
  1539.      * IUnknown methods
  1540.      */
  1542.     STDMETHOD(QueryInterface)   (THIS_
  1543.                                 REFIID riid,
  1544.                                 void** ppvObj) PURE;
  1546.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1548.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1550.     /*
  1551.      * IHXFileMove methods
  1552.      */
  1554.     /************************************************************************
  1555.      * Method:
  1556.      *     IHXFileMove::Move
  1557.      * Purpose:
  1558.      *     Moves a file to a different location in the file system
  1559.      */
  1560.     STDMETHOD(Move) (THIS_
  1561. const char* pNewFilePathName) PURE;
  1562. };
  1563.     
  1565. /****************************************************************************
  1566.  * 
  1567.  *  Interface:
  1568.  * 
  1569.  * IHXDirHandler
  1570.  * 
  1571.  *  Purpose:
  1572.  * 
  1573.  * Object that exports directory handler API
  1574.  * 
  1575.  *  IID_IHXDirHandler:
  1576.  * 
  1577.  * {00000215-0901-11d1-8B06-00A024406D59}
  1578.  * 
  1579.  */
  1580. DEFINE_GUID(IID_IHXDirHandler, 0x00000215, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1582. #undef  INTERFACE
  1583. #define INTERFACE   IHXDirHandler
  1585. DECLARE_INTERFACE_(IHXDirHandler, IUnknown)
  1586. {
  1587.     /*
  1588.      * IUnknown methods
  1589.      */
  1590.     STDMETHOD(QueryInterface) (THIS_
  1591. REFIID riid,
  1592. void** ppvObj) PURE;
  1594.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1596.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1598.     /*
  1599.      * IHXDirHandler methods
  1600.      */
  1602.     /************************************************************************
  1603.      * Method:
  1604.      *     IHXDirHandler::InitDirHandler
  1605.      * Purpose:
  1606.      *     Associates a directory handler with the directory handler
  1607.      *     response, it should notify of operation completness.
  1608.      */
  1609.     STDMETHOD(InitDirHandler) (THIS_
  1610. IHXDirHandlerResponse*    /*IN*/  pDirResponse) PURE;
  1612.     /************************************************************************
  1613.      * Method:
  1614.      *     IHXDirHandler::CloseDirHandler
  1615.      * Purpose:
  1616.      *     Closes the directory handler resource and releases all resources
  1617.      *     associated with the object.
  1618.      */
  1619.     STDMETHOD(CloseDirHandler) (THIS) PURE;
  1621.     /************************************************************************
  1622.      * Method:
  1623.      *     IHXDirHandler::MakeDir
  1624.      * Purpose:
  1625.      *     Create the directory
  1626.      */
  1627.     STDMETHOD(MakeDir) (THIS) PURE;
  1629.     /************************************************************************
  1630.      * Method:
  1631.      *     IHXDirHandler::ReadDir
  1632.      * Purpose:
  1633.      *     Get a dump of the directory
  1634.      */
  1635.     STDMETHOD(ReadDir) (THIS) PURE;
  1636. };
  1639. /****************************************************************************
  1640.  * 
  1641.  *  Interface:
  1642.  * 
  1643.  * IHXDirHandlerResponse
  1644.  * 
  1645.  *  Purpose:
  1646.  * 
  1647.  * Object that exports the directory handler response API
  1648.  * 
  1649.  *  IID_IHXDirHandlerResponse:
  1650.  * 
  1651.  * {00000216-0901-11d1-8B06-00A024406D59}
  1652.  * 
  1653.  */
  1654. DEFINE_GUID(IID_IHXDirHandlerResponse, 0x00000216, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1656. #undef  INTERFACE
  1657. #define INTERFACE   IHXDirHandlerResponse
  1659. DECLARE_INTERFACE_(IHXDirHandlerResponse, IUnknown)
  1660. {
  1661.     /*
  1662.      * IUnknown methods
  1663.      */
  1664.     STDMETHOD(QueryInterface) (THIS_
  1665. REFIID riid,
  1666. void** ppvObj) PURE;
  1668.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1670.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1672.     /*
  1673.      * IHXDirHandlerResponse methods
  1674.      */
  1676.     /************************************************************************
  1677.      * Method:
  1678.      *     IHXDirHandlerResponse::InitDirHandlerDone
  1679.      * Purpose:
  1680.      *     Notification interface provided by users of the IHXDirHandler
  1681.      *     interface. This method is called by the IHXDirHandler when the
  1682.      *     initialization of the object is complete.
  1683.      */
  1684.     STDMETHOD(InitDirHandlerDone) (THIS_
  1685. HX_RESULT     status) PURE;
  1687.     /************************************************************************
  1688.      * Method:
  1689.      *     IHXDirHandlerResponse::CloseDirHandlerDone
  1690.      * Purpose:
  1691.      *     Notification interface provided by users of the IHXDirHandler
  1692.      *     interface. This method is called by the IHXDirHandler when the
  1693.      *     close of the directory is complete.
  1694.      */
  1695.     STDMETHOD(CloseDirHandlerDone) (THIS_
  1696. HX_RESULT     status) PURE;
  1698.     /************************************************************************
  1699.      * Method:
  1700.      *     IHXDirHandler::MakeDirDone
  1701.      * Purpose:
  1702.      *     Notification interface provided by users of the IHXDirHandler
  1703.      *     interface. This method is called by the IHXDirHandler when the
  1704.      *     attempt to create the directory is complete.
  1705.      */
  1706.     STDMETHOD(MakeDirDone) (THIS_ 
  1707. HX_RESULT     status) PURE;
  1709.     /************************************************************************
  1710.      * Method:
  1711.      *     IHXDirHandler::ReadDirDone
  1712.      * Purpose:
  1713.      *     Notification interface provided by users of the IHXDirHandler
  1714.      *     interface. This method is called by the IHXDirHandler when the
  1715.      *     read from the directory is complete and a buffer is available.
  1716.      */
  1717.     STDMETHOD(ReadDirDone) (THIS_ 
  1718. HX_RESULT     status,
  1719. IHXBuffer*     pBuffer) PURE;
  1720. };
  1723. // $Private:
  1724. /****************************************************************************
  1725.  * 
  1726.  *  Interface:
  1727.  * 
  1728.  * IHXGetRecursionLevel
  1729.  * 
  1730.  *  Purpose:
  1731.  * 
  1732.  * Set's Recursion Level
  1733.  * 
  1734.  *  IID_GetRecursionLevel:
  1735.  * 
  1736.  * {00000218-0901-11d1-8B06-00A024406D59}
  1737.  * 
  1738.  */
  1739. DEFINE_GUID(IID_IHXGetRecursionLevel, 0x00000218, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1741. #undef  INTERFACE
  1742. #define INTERFACE   IHXGetRecursionLevel
  1744. DECLARE_INTERFACE_(IHXGetRecursionLevel, IUnknown)
  1745. {
  1746.     /*
  1747.      * IUnknown methods
  1748.      */
  1749.     STDMETHOD(QueryInterface) (THIS_
  1750. REFIID riid,
  1751. void** ppvObj) PURE;
  1753.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1755.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1757.     /*
  1758.      * IHXGetRecursionLevel methods
  1759.      */
  1761.     STDMETHOD_(UINT32, GetRecursionLevel) (THIS) PURE;
  1762. };
  1764. /****************************************************************************
  1765.  * 
  1766.  *  Interface:
  1767.  * 
  1768.  * IHXFileRestrictor
  1769.  * 
  1770.  *  Purpose:
  1771.  * 
  1772.  * Allows restrictions on per file basis.  This will only get called for
  1773.  *  HTTP and it will only send in the localport.  Maybe some day.....
  1774.  * 
  1775.  *  IID_IHXFileRestrictor:
  1776.  * 
  1777.  * {00000219-0901-11d1-8B06-00A024406D59}
  1778.  * 
  1779.  */
  1780. DEFINE_GUID(IID_IHXFileRestrictor, 0x00000219, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1782. #undef  INTERFACE
  1783. #define INTERFACE   IHXFileRestrictor
  1785. DECLARE_INTERFACE_(IHXFileRestrictor, IUnknown)
  1786. {
  1787.     /*
  1788.      * IUnknown methods
  1789.      */
  1790.     STDMETHOD(QueryInterface) (THIS_
  1791. REFIID riid,
  1792. void** ppvObj) PURE;
  1794.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  1796.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1798.     /*
  1799.      * IHXFileRestrictor methods
  1800.      */
  1802.     STDMETHOD_(BOOL, IsAllowed) (THIS_
  1803. const char* url,
  1804. ULONG32 LocalAddr,
  1805. UINT16 LocalPort,
  1806. ULONG32 RemoteAddr,
  1807. UINT16 RemotePort) PURE;
  1808. };
  1810. // $EndPrivate.
  1812. /****************************************************************************
  1813.  * 
  1814.  *  Interface:
  1815.  * 
  1816.  * IHXFileRemove
  1817.  * 
  1818.  *  Purpose:
  1819.  * 
  1820.  *      Interface to allow removing of files.  Query off of the File Object.
  1821.  * Not all filesystem plugins implement this feature.
  1822.  * 
  1823.  *  IID_IHXFileRemove:
  1824.  *  
  1825.  * {0000021A-0901-11d1-8B06-00A024406D59}
  1826.  * 
  1827.  */
  1828. DEFINE_GUID(IID_IHXFileRemove, 0x0000021A, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1829. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1830. #undef  INTERFACE
  1831. #define INTERFACE   IHXFileRemove
  1833. DECLARE_INTERFACE_(IHXFileRemove, IUnknown)
  1834. {
  1835.     /*
  1836.      * IUnknown methods
  1837.      */
  1839.     STDMETHOD(QueryInterface)   (THIS_
  1840.                                 REFIID riid,
  1841.                                 void** ppvObj) PURE;
  1843.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1845.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1847.     /*
  1848.      * IHXFileRemove methods
  1849.      */
  1851.     /************************************************************************
  1852.      * Method:
  1853.      *     IHXFileRemove::Remove
  1854.      * Purpose:
  1855.      *     Removes a file from the file system.
  1856.      */
  1857.     STDMETHOD(Remove) (THIS) PURE;
  1858. };
  1861. // $Private:
  1862. /****************************************************************************
  1863.  * 
  1864.  *  Interface:
  1865.  * 
  1866.  * IHXFastFileFactory
  1867.  * 
  1868.  *  Purpose:
  1869.  * 
  1870.  *      Interface to allow wrapping file objects with a buffer and block-sharing
  1871.  * sceme.  Query off the server class factory.
  1872.  * 
  1873.  *  IID_IHXFastFileFactory:
  1874.  *  
  1875.  * {0000021C-0901-11d1-8B06-00A024406D59}
  1876.  * 
  1877.  */
  1878. DEFINE_GUID(IID_IHXFastFileFactory, 0x0000021C, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1879. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1881. #define CLSID_IHXFastFileFactory IID_IHXFastFileFactory
  1883. #undef  INTERFACE
  1884. #define INTERFACE   IHXFastFileFactory
  1886. DECLARE_INTERFACE_(IHXFastFileFactory, IUnknown)
  1887. {
  1888.     /*
  1889.      * IUnknown methods
  1890.      */
  1892.     STDMETHOD(QueryInterface)   (THIS_
  1893.                                 REFIID riid,
  1894.                                 void** ppvObj) PURE;
  1896.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1898.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1900.     /*
  1901.      * IHXFastFileFactory methods
  1902.      */
  1904.     /************************************************************************
  1905.      * Method:
  1906.      *     IHXFastFileFactory::Wrap
  1907.      * Purpose:
  1908.      *     Return an instantiated wrapper around an existing (but
  1909.      *      uninitialized) file object.
  1910.      *
  1911.      */
  1912.     STDMETHOD(Wrap) (THIS_
  1913.  REF(IUnknown*) /*OUT*/ pWrapper,
  1914.  IUnknown*      /*IN*/  pFileObj,
  1915.  UINT32         /*IN*/  ulBlockSize,
  1916.                                  BOOL           /*IN*/  bAlignReads,
  1917.                                  BOOL           /*IN*/  bCacheStats) PURE;
  1918. };
  1921. /****************************************************************************
  1922.  *
  1923.  *  Interface:
  1924.  *
  1925.  *      IHXFastFileFactory2
  1926.  *
  1927.  *  Purpose:
  1928.  *
  1929.  *      Interface to allow wrapping file objects with a buffer and block-sharing
  1930.  *      sceme.  Query off the server class factory.
  1931.  *
  1932.  *  IID_IHXFastFileFactory2:
  1933.  * 
  1934.  *      {0000021F-0901-11d1-8B06-00A024406D59}
  1935.  *
  1936.  */
  1937. DEFINE_GUID(IID_IHXFastFileFactory2, 0x0000021F, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  1938.                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  1940. #define CLSID_IHXFastFileFactory2 IID_IHXFastFileFactory2
  1942. #undef  INTERFACE
  1943. #define INTERFACE   IHXFastFileFactory2
  1945. DECLARE_INTERFACE_(IHXFastFileFactory2, IUnknown)
  1946. {
  1947.     /************************************************************************
  1948.      *  Method:
  1949.      *      IHXFastFileFactory2::Wrap
  1950.      *  Purpose:
  1951.      *      Return an instantiated wrapper around an existing (but
  1952.      *      uninitialized) file object.
  1953.      *
  1954.      */
  1955.     STDMETHOD(Wrap)             (THIS_
  1956.                                  REF(IUnknown*) /*OUT*/ pWrapper,
  1957.                                  IUnknown*      /*IN*/  pFileObj,
  1958.                                  UINT32         /*IN*/  ulBlockSize,
  1959.                                  BOOL           /*IN*/  bAlignReads,
  1960.                                  BOOL           /*IN*/  bCacheStats,
  1961.                                  UINT32         /*IN*/  ulMaxBlockSize) PURE;
  1962. };
  1965. /****************************************************************************
  1966.  * 
  1967.  *  Interface:
  1968.  * 
  1969.  * IHXFilePlacementRead
  1970.  * 
  1971.  *  Purpose:
  1972.  * 
  1973.  *      Reads into the passed buffer
  1974.  * 
  1975.  *  IID_IHXFilePlacementRead
  1976.  * 
  1977.  * {0000021D-0901-11d1-8B06-00A024406D59}
  1978.  * 
  1979.  */
  1980. DEFINE_GUID(IID_IHXFilePlacementRead, 0x0000021D, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  1981. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  1983. #undef  INTERFACE
  1984. #define INTERFACE   IHXFilePlacementRead
  1986. DECLARE_INTERFACE_(IHXFilePlacementRead, IUnknown)
  1987. {
  1988.     /*
  1989.      * IUnknown methods
  1990.      */
  1991.     STDMETHOD(QueryInterface)   (THIS_
  1992.                                 REFIID riid,
  1993.                                 void** ppvObj) PURE;
  1995.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  1997.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  1999.     /*
  2000.      * IHXFilePlacementRead methods
  2001.      */
  2002.     STDMETHOD(Read) (THIS_
  2003.                                 ULONG32 ulAmount,
  2004.                                 ULONG32 ulOffset,
  2005.                                 char*   pBuffer,
  2006.                                 BOOL    bOffsetBuffer) PURE;
  2008.     STDMETHOD_(ULONG32,AlignmentBoundary) (THIS) PURE;
  2009. };
  2011. // $EndPrivate.
  2013. /****************************************************************************
  2014.  * 
  2015.  *  Interface:
  2016.  * 
  2017.  * IHXFastFileStats
  2018.  * 
  2019.  *  Purpose:
  2020.  * 
  2021.  *      Interface to allow file objects to request that at close they be 
  2022.  *      informed how many bytes have been "fast cached" on their behalf if any.
  2023.  * 
  2024.  *      ulFastFileBytesSaved is the number of bytes that would have been read
  2025.  *      from the file object had FastFile not been in use (this includes some
  2026.  *      lookahead
  2027.  *
  2028.  *      ulFastFileBytesNeeded is the amount of data actually read by the file 
  2029.  *      system. 
  2030.  * 
  2031.  *  IID_IHXFastFileStats:
  2032.  *  
  2033.  * {0000021E-0901-11d1-8B06-00A024406D59}
  2034.  * 
  2035.  */
  2036. DEFINE_GUID(IID_IHXFastFileStats, 0x0000021E, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  2037. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  2039. #define CLSID_IHXFastFileStats IID_IHXFastFileStats
  2041. #undef  INTERFACE
  2042. #define INTERFACE   IHXFastFileStats
  2044. DECLARE_INTERFACE_(IHXFastFileStats, IUnknown)
  2045. {
  2046.     /*
  2047.      * IUnknown methods
  2048.      */
  2050.     STDMETHOD(QueryInterface)   (THIS_
  2051.                                 REFIID riid,
  2052.                                 void** ppvObj) PURE;
  2054.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  2056.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2058.     /*
  2059.      * IHXFastFileStats methods
  2060.      */
  2062.     STDMETHOD(UpdateFileObjectStats) (THIS_
  2063.                                          UINT32         /*IN*/  ulFastFileBytesSaved,
  2064.                                          UINT32         /*IN*/  ulFastFileBytesNeeded) PURE;
  2065. };
  2067. // $Private:
  2068. /****************************************************************************
  2069.  * 
  2070.  *  Interface:
  2071.  * 
  2072.  * IHXHTTPPostObject
  2073.  * 
  2074.  *  Purpose:
  2075.  * 
  2076.  * Object that exports file control API
  2077.  * 
  2078.  *  IID_IHXHTTPPostObject:
  2079.  * 
  2080.  * {00000112-0901-11d1-8B06-00A024406D59}
  2081.  * 
  2082.  */
  2084. DEFINE_GUID(IID_IHXHTTPPostObject, 0x00000112, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  2085. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  2087. #define CLSID_IHXHTTPPostObject IID_IHXHTTPPostObject
  2089. #undef  INTERFACE
  2090. #define INTERFACE   IHXHTTPPostObject
  2092. DECLARE_INTERFACE_(IHXHTTPPostObject, IUnknown)
  2093. {
  2094.     /*
  2095.      * IUnknown methods
  2096.      */
  2097.     STDMETHOD(QueryInterface) (THIS_
  2098. REFIID riid,
  2099. void** ppvObj) PURE;
  2101.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2103.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2105.     /*
  2106.      * IHXHTTPPostObject methods
  2107.      */
  2109.     /************************************************************************
  2110.      * Method:
  2111.      *     IHXHTTPPostObject::Init
  2112.      * Purpose:
  2113.      *     Associates a file object with the file response object it should
  2114.      *     notify of operation completness. This method should also check
  2115.      *     for validity of the object (for example by opening it if it is
  2116.      *     a local file).
  2117.      */
  2118.     STDMETHOD(Init) (THIS_
  2119. ULONG32     /*IN*/  ulFlags,
  2120. IHXHTTPPostResponse*   /*IN*/  pFileResponse) PURE;
  2122.     /************************************************************************
  2123.      * Method:
  2124.      *     IHXHTTPPostObject::Close
  2125.      * Purpose:
  2126.      *     Closes the file resource and releases all resources associated
  2127.      *     with the object.
  2128.      */
  2129.     STDMETHOD(Close) (THIS) PURE;
  2131.     /************************************************************************
  2132.      * Method:
  2133.      *     IHXHTTPPostObject::GetResponse
  2134.      * Purpose:
  2135.      *     Tells the object to retreive any response data from the POST.
  2136.      *     Calls IHXHTTPPostResponse with ResponseReady(IHXValues*).
  2137.      */
  2138.     STDMETHOD(GetResponse) (THIS) PURE;
  2141.     /************************************************************************
  2142.      * Method:
  2143.      *     IHXHTTPPostObject::Post
  2144.      * Purpose:
  2145.      *     Writes a buffer of data to the HTTP URL and asynchronously notifies
  2146.      *     the caller via the IHXFileResponse interface passed in to Init,
  2147.      *     of the completeness of the operation.
  2148.      */
  2149.     STDMETHOD(Post) (THIS_
  2150. IHXBuffer* pBuffer) PURE;
  2152. /************************************************************************
  2153.      * Method:
  2154.      *     IHXHTTPPostObject::SetSize
  2155.      * Purpose:
  2156.      *      Set the total size of the Post(s) about to be made.
  2157.      */
  2158.     STDMETHOD(SetSize) (THIS_
  2159. ULONG32 ulLength) PURE;
  2160. };
  2163. /****************************************************************************
  2164.  * 
  2165.  *  Interface:
  2166.  * 
  2167.  * IHXHTTPPostResponse
  2168.  * 
  2169.  *  Purpose:
  2170.  * 
  2171.  * Object that exports file response API
  2172.  * 
  2173.  *  IID_IHXHTTPPostResponse:
  2174.  * 
  2175.  * {00000113-0901-11d1-8B06-00A024406D59}
  2176.  * 
  2177.  */
  2178. DEFINE_GUID(IID_IHXHTTPPostResponse, 0x00000113, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  2179.     0xa0, 0x24, 0x40, 0x6d, 0x59);
  2181. #undef  INTERFACE
  2182. #define INTERFACE   IHXHTTPPostResponse
  2184. DECLARE_INTERFACE_(IHXHTTPPostResponse, IUnknown)
  2185. {
  2186.     /*
  2187.      * IUnknown methods
  2188.      */
  2189.     STDMETHOD(QueryInterface) (THIS_
  2190. REFIID riid,
  2191. void** ppvObj) PURE;
  2193.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2195.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2197.     /*
  2198.      * IHXHTTPPostResponse methods
  2199.      */
  2201.     /************************************************************************
  2202.      * Method:
  2203.      *     IHXHTTPPostResponse::InitDone
  2204.      * Purpose:
  2205.      *     Notification interface provided by users of the IHXHTTPPostObject
  2206.      *     interface. This method is called by the IHXHTTPPostObject when the
  2207.      *     initialization of the file is complete. If the file is not valid 
  2208.      *     for the file system, the status HXR_FAILED should be 
  2209.      *     returned.
  2210.      */
  2211.     STDMETHOD(InitDone) (THIS_
  2212. HX_RESULT     status) PURE;
  2214.     /************************************************************************
  2215.      * Method:
  2216.      *     IHXHTTPPostResponse::CloseDone
  2217.      * Purpose:
  2218.      *     Notification interface provided by users of the IHXHTTPPostObject
  2219.      *     interface. This method is called by the IHXHTTPPostObject when the
  2220.      *     close of the file is complete.
  2221.      */
  2222.     STDMETHOD(CloseDone) (THIS_
  2223. HX_RESULT     status) PURE;
  2225.     /************************************************************************
  2226.      * Method:
  2227.      *     IHXHTTPPostResponse::ResponseReady
  2228.      * Purpose:
  2229.      *     Notification interface provided by users of the IHXHTTPPostObject
  2230.      *     interface. This method is called by the IHXHTTPPostObject when the
  2231.      *     POST response data has been completely read.
  2232.      */
  2233.     STDMETHOD(ResponseReady) (THIS_ 
  2234. HX_RESULT     status,
  2235. IHXBuffer*     pContentBuffer) PURE;
  2237.     /************************************************************************
  2238.      * Method:
  2239.      *     IHXHTTPPostResponse::WriteDone
  2240.      * Purpose:
  2241.      *     Notification interface provided by users of the IHXHTTPPostObject
  2242.      *     interface. This method is called by the IHXHTTPPostObject when the
  2243.      *     last write to the file is complete.
  2244.      */
  2245.     STDMETHOD(PostDone) (THIS_ 
  2246. HX_RESULT     status) PURE;
  2247. };
  2248. // $EndPrivate.
  2251. // $Private:
  2252. /****************************************************************************
  2253.  * 
  2254.  *  Interface:
  2255.  * 
  2256.  * IHXHTTPRedirect
  2257.  * 
  2258.  *  Purpose:
  2259.  * 
  2260.  * Allows you to get redirect URL
  2261.  * 
  2262.  *  IID_IHXHTTPRedirect:
  2263.  * 
  2264.  * {00002E00-0901-11d1-8B06-00A024406D59}
  2265.  * 
  2266.  */
  2268. DEFINE_GUID(IID_IHXHTTPRedirect, 0x21eae0b9, 0x2e0c, 0x4003, 0xbb, 0x79,
  2269.             0xbc, 0x8c, 0xc5, 0x67, 0x2c, 0x2d);
  2271. #undef  INTERFACE
  2272. #define INTERFACE   IHXHTTPRedirect
  2274. DECLARE_INTERFACE_(IHXHTTPRedirect, IUnknown)
  2275. {
  2276.     /*
  2277.      * IUnknown methods
  2278.      */
  2279.     STDMETHOD(QueryInterface) (THIS_
  2280. REFIID riid,
  2281. void** ppvObj) PURE;
  2283.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2285.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2287.     /*
  2288.      * IHXHTTPRedirect methods
  2289.      */
  2291.     /************************************************************************
  2292.      * Method:
  2293.      *     IHXHTTPRedirect::Init
  2294.      * Purpose:
  2295.      *     Initialize the response object
  2296.      */
  2297.     STDMETHOD(Init)     (THIS_
  2298.      IHXHTTPRedirectResponse* pRedirectResponse) PURE;
  2300.     /************************************************************************
  2301.      * Method:
  2302.      *     IHXHTTPRedirect::SetResponseObject
  2303.      * Purpose:
  2304.      *     Initialize the response object w/o calling Init
  2305.      */
  2306.     STDMETHOD(SetResponseObject) (THIS_ 
  2307.                              IHXHTTPRedirectResponse* pRedirectResponse) PURE;
  2309. };
  2311. /****************************************************************************
  2312.  * 
  2313.  *  Interface:
  2314.  * 
  2315.  * IHXHTTPRedirectResponse
  2316.  * 
  2317.  *  Purpose:
  2318.  * 
  2319.  * Allows you to get redirect URL
  2320.  * 
  2321.  *  IID_IHXHTTPRedirectResponse:
  2322.  * 
  2323.  * {00002E01-0901-11d1-8B06-00A024406D59}
  2324.  * 
  2325.  */
  2327. DEFINE_GUID(IID_IHXHTTPRedirectResponse, 0x125a63b1, 0x669c, 0x42f9, 0xb1,
  2328.             0xf9, 0x1b, 0x53, 0xe9, 0x95, 0x82, 0x95);
  2330. #undef  INTERFACE
  2331. #define INTERFACE   IHXHTTPRedirectResponse
  2333. DECLARE_INTERFACE_(IHXHTTPRedirectResponse, IUnknown)
  2334. {
  2335.     /*
  2336.      * IUnknown methods
  2337.      */
  2338.     STDMETHOD(QueryInterface) (THIS_
  2339. REFIID riid,
  2340. void** ppvObj) PURE;
  2342.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2344.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2346.     /*
  2347.      * IHXHTTPRedirectResponse methods
  2348.      */
  2350.     /************************************************************************
  2351.      * Method:
  2352.      *     IHXHTTPRedirectResponse::RedirectDone
  2353.      * Purpose:
  2354.      *     return the redirect URL
  2355.      */
  2356.     STDMETHOD(RedirectDone) (THIS_
  2357.  IHXBuffer* pURL) PURE;
  2359. };
  2361. /****************************************************************************
  2362.  * 
  2363.  *  Interface:
  2364.  *
  2365.  * IHXRM2Converter2
  2366.  *
  2367.  *  Purpose:
  2368.  *
  2369.  * Interface to RM1->RM2 merge/converter module. This is a new improved
  2370.  *      interface which contains all of the functionality of the old one.
  2371.  *      However, this one is asynchronous where necessary and takes standard
  2372.  *      IHXFileObjects instead of pathnames for the required files.
  2373.  *
  2374.  *  IHXRM2Converter
  2375.  *
  2376.  * {00002F00-0901-11D1-8B06-00A024406D59}
  2377.  */
  2379. DEFINE_GUID(IID_IHXRM2Converter2, 0x00002F00, 0x901, 0x11d1, 0x8b, 
  2380.     0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  2382. #define CLSID_IRMARM2Converter2 IID_IHXRM2Converter2
  2384. #undef  INTERFACE
  2385. #define INTERFACE   IHXRM2Converter2
  2387. DECLARE_INTERFACE_(IHXRM2Converter2, IUnknown)
  2388. {
  2389.     /*
  2390.      * IUnknown methods
  2391.      */
  2392.     STDMETHOD(QueryInterface)     (THIS_
  2393.     REFIID riid,
  2394.     void** ppvObj) PURE;
  2395.     STDMETHOD_(ULONG32,AddRef)     (THIS) PURE;
  2396.     STDMETHOD_(ULONG32,Release)     (THIS) PURE;
  2398.     /*
  2399.      * IHXRM2Converter2 methods
  2400.      */
  2401.     STDMETHOD(Init)     (THIS_
  2402.     IHXRM2Converter2Response* pResponse) PURE;
  2403.     //
  2404.     // AddStream takes a stream from an RM1 file and
  2405.     // adds it to the new RM2 multirate section
  2406.     //
  2407.     STDMETHOD(AddStream)     (THIS_
  2408.     const char* pFilename,
  2409.     IHXFileObject* pFileObject,
  2410.     UINT16 nStreamNumber,
  2411.     BOOL bTagAsBackwardCompatible) PURE;
  2413.     //
  2414.     // AddInterleavedStream takes a stream from an
  2415.     // RM1 file and adds it to the initial interleaved
  2416.     // backward compatibility section
  2417.     //
  2418.     STDMETHOD(AddInterleavedStream) (THIS_
  2419.     const char* pFilename,
  2420.     IHXFileObject* pFileObject,
  2421.     UINT16 nStreamNumber) PURE;
  2423.     //
  2424.     // Add file slurps down all of the streams in
  2425.     // an RM1 file and adds them to the new RM2
  2426.     // multirate section.
  2427.     //
  2428.     STDMETHOD(AddFile)     (THIS_
  2429.     const char* pFilename,
  2430.     IHXFileObject* pFileObject) PURE;
  2432.     //
  2433.     // SetTitle,Author,Copyright, and Comment
  2434.     // should all be pretty self explanatory...
  2435.     //
  2436.     STDMETHOD(SetTitle)     (THIS_
  2437.     const char* pTitle) PURE;
  2438.     STDMETHOD(SetAuthor)     (THIS_
  2439.     const char* pAuthor) PURE;
  2440.     STDMETHOD(SetCopyright)     (THIS_
  2441.     const char* pCopyright) PURE;
  2442.     STDMETHOD(SetComment)     (THIS_
  2443.     const char* pComment) PURE;
  2445.     //
  2446.     // PairStreams lets you pair two different
  2447.     // streams together to play at a particular
  2448.     // bandwidth (i.e. the sum of the stream
  2449.     // bandwidths involved).
  2450.     //
  2451.     STDMETHOD(PairStreams)     (THIS_
  2452.     const char* pFilename1,
  2453.     UINT16 nStreamNumber1,
  2454.     const char* pFilename2,
  2455.     UINT16 nStreamNumber2) PURE;
  2457.     STDMETHOD(Merge) (THIS_
  2458. const char* pFilename,
  2459. IHXFileObject* pOutputFile,
  2460. UINT32 ulBytesToWrite) PURE;
  2462.     STDMETHOD(Reset)     (THIS) PURE;
  2463.     STDMETHOD(Done)     (THIS) PURE;
  2464. };
  2467. /****************************************************************************
  2468.  * 
  2469.  *  Interface:
  2470.  *
  2471.  * IHXRM2Converter2Response
  2472.  *
  2473.  *  Purpose:
  2474.  *
  2475.  * Response Interface for IHXRM2Converter2. 
  2476.  *
  2477.  *  IHXRM2Converter
  2478.  *
  2479.  * {00002F01-0901-11D1-8B06-00A024406D59}
  2480.  */
  2482. DEFINE_GUID(IID_IHXRM2Converter2Response, 0x00002F01, 0x901, 0x11d1, 0x8b, 
  2483.     0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  2486. #undef  INTERFACE
  2487. #define INTERFACE   IHXRM2Converter2Response
  2489. DECLARE_INTERFACE_(IHXRM2Converter2Response, IUnknown)
  2490. {
  2491.     /*
  2492.      * IUnknown methods
  2493.      */
  2494.     STDMETHOD(QueryInterface) (THIS_
  2495. REFIID riid,
  2496. void** ppvObj) PURE;
  2497.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2498.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2500.     /*
  2501.      * IHXRM2Converter2Response methods
  2502.      */
  2503.     STDMETHOD(InitDone) (THIS_
  2504. HX_RESULT status) PURE;
  2505.     STDMETHOD(AddStreamDone) (THIS_
  2506. HX_RESULT status) PURE;
  2507.     STDMETHOD(AddInterleavedStreamDone) (THIS_
  2508. HX_RESULT status) PURE;
  2509.     STDMETHOD(AddFileDone) (THIS_
  2510. HX_RESULT status) PURE;
  2511.     STDMETHOD(MergeDone) (THIS_
  2512. HX_RESULT status) PURE;
  2513. };
  2516. /****************************************************************************
  2517.  * 
  2518.  *  Interface:
  2519.  * 
  2520.  * IHXPoolPathAdjustment
  2521.  * 
  2522.  *  Purpose:
  2523.  * 
  2524.  * For file systems that use GetFileObjectFromPool to properly
  2525.  * adjust absolute local URLs so they will be accessed relative
  2526.  *      to the pool filesystem mountpoint.
  2527.  *
  2528.  *  IID_IHXPoolPathAdjustment:
  2529.  * 
  2530.  * {00002F02-0901-11d1-8b06-00A024406D59}
  2531.  * 
  2532.  */
  2533. DEFINE_GUID(IID_IHXPoolPathAdjustment, 0x00002F02, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  2535. #undef  INTERFACE
  2536. #define INTERFACE   IHXPoolPathAdjustment
  2538. DECLARE_INTERFACE_(IHXPoolPathAdjustment, IUnknown)
  2539. {
  2540.     /*
  2541.      * IUnknown methods
  2542.      */
  2543.     STDMETHOD(QueryInterface) (THIS_
  2544. REFIID riid,
  2545. void** ppvObj) PURE;
  2547.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2549.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2551.     /*
  2552.      * IHXPoolPathAdjustment Methods.
  2553.      */
  2554.     STDMETHOD(AdjustAbsolutePath)   (THIS_
  2555.          IHXBuffer*      /*IN*/  pOldPath,
  2556.          REF(IHXBuffer*) /*OUT*/ pNewPath) PURE;
  2558. };
  2560. /*
  2561.  * Interface:
  2562.  *  IHXPostDataHandler
  2563.  *
  2564.  * Purpose:
  2565.  *
  2566.  *  Allows a file object to receive out of band POST data
  2567.  *      from an HTTP request.  If this interface is not implemented
  2568.  *      data will be placed in request header as "PostData"
  2569.  *
  2570.  *      When there is no more Data remaining, PostData will be
  2571.  *      called with a NULL argument.
  2572.  *
  2573.  * IID_IHXPostDataHandler:
  2574.  *
  2575.  * {0x0222a1b5-49fc-47e2-b69098befa0a588e}
  2576.  *
  2577.  */
  2578. DEFINE_GUID(IID_IHXPostDataHandler, 0x0222a1b5, 0x49fc, 0x47e2, 0xb6,
  2579. 0x90, 0x98, 0xbe, 0xfa, 0x0a, 0x58, 0x8e);
  2581. #undef INTERFACE
  2582. #define INTERFACE IHXPostDataHandler
  2584. DECLARE_INTERFACE_(IHXPostDataHandler, IUnknown)
  2585. {
  2586.     /*
  2587.      * IUnknownMethods
  2588.      */
  2590.     STDMETHOD(QueryInterface) (THIS_
  2591.     REFIID riid,
  2592.     void** ppvObj) PURE;
  2594.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  2596.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  2597.     /*
  2598.      * IHXPostDataHandler methods
  2599.      */
  2600.     STDMETHOD(PostData) (THIS_
  2601.          IHXBuffer* pBuf) PURE;
  2602. };
  2604. // $EndPrivate.
  2606. #endif  /* _HXFILES_H_ */