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

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _HXERROR_H_
  36. #define _HXERROR_H_
  37. /*
  38.  * Forward declarations of some interfaces defined here-in.
  39.  */
  40. typedef _INTERFACE       IHXBuffer          IHXBuffer;
  41. typedef _INTERFACE       IHXErrorSinkControl     IHXErrorSinkControl;
  42. /* Message Severity values */
  43. enum {
  44.      HXLOG_EMERG     = 0, /* A panic condition.  Server / Player will halt or
  45.      restart. */
  46.      HXLOG_ALERT     = 1, /* A condition that should be corrected immediately.
  47.      Needs user intervention to prevent problems. */
  48.      HXLOG_CRIT      = 2, /* Critical conditions. */
  49.      HXLOG_ERR       = 3, /* Errors. */
  50.      HXLOG_WARNING   = 4, /* Warning messages. */
  51.      HXLOG_NOTICE    = 5, /* Conditions that are not error conditions, but
  52.      should possibly be handled specially. */
  53.      HXLOG_INFO      = 6, /* Informational messages. */
  54.      HXLOG_DEBUG     = 7  /* Messages that contain information normally of use
  55.      only when debugging a program. */
  56. };
  57. /****************************************************************************
  58.  * 
  59.  *  Interface:
  60.  * 
  61.  * IHXErrorMessages
  62.  * 
  63.  *  Purpose:
  64.  * 
  65.  * Error, event, and status message reporting interface
  66.  * 
  67.  *  IID_IHXErrorMessages:
  68.  * 
  69.  * {00000800-0901-11d1-8B06-00A024406D59}
  70.  * 
  71.  */
  72. DEFINE_GUID(IID_IHXErrorMessages, 0x00000800, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  73. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  74. #undef  INTERFACE
  75. #define INTERFACE   IHXErrorMessages
  76. DECLARE_INTERFACE_(IHXErrorMessages, IUnknown)
  77. {
  78.     /*
  79.      *  IUnknown methods
  80.      */
  81.     STDMETHOD(QueryInterface) (THIS_
  82. REFIID riid,
  83. void** ppvObj) PURE;
  84.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  85.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  86.     /*
  87.      *  IHXErrorMessages methods
  88.      */
  89.     /************************************************************************
  90.      * Method:
  91.      *     IHXErrorMessages::Report
  92.      * Purpose:
  93.      *     Call this method to report an error, event, or status message.
  94.      * Parameters:
  95.      *
  96.      *     const UINT8 unSeverity
  97.      *     Type of report. This value will impact how the player, tool, or
  98.      *     server will react to the report. Possible values are described 
  99.      *     above. Depending on the error type, an error message with the 
  100.      *     HXR code, anda string translation of that code will be displayed. 
  101.      *     The error dialog includes a "more info" section that displays the
  102.      *     user code and string, and a link to the more info URL. In the 
  103.      *     server these messages are logged to the log file.
  104.      *
  105.      *     const ULONG32   ulHXCode
  106.      *     Well known HXR error code. This will be translated to a text
  107.      *     representation for display in an error dialog box or log file.
  108.      *
  109.      *     const ULONG32   ulUserCode
  110.      *     User specific error code. This will NOT be translated to a text
  111.      *     representation. This can be any value the caller wants, it will
  112.      *     be logged or displayed but not interpretted.
  113.      *
  114.      *     const char*     pUserString
  115.      *     User specific error string. This will NOT be translated or 
  116.      *     modified. This can be any value the caller wants, it will
  117.      *     be logged or displayed but not interpretted.
  118.      *
  119.      *     const char*     pMoreInfoURL
  120.      *     User specific more info URL string.
  121.      *
  122.      */
  123.     STDMETHOD(Report) (THIS_
  124. const UINT8 unSeverity,  
  125. HX_RESULT ulHXCode,
  126. const ULONG32 ulUserCode,
  127. const char* pUserString,
  128. const char* pMoreInfoURL) PURE;
  129.     /************************************************************************
  130.      * Method:
  131.      *     IHXErrorMessages::GetErrorText
  132.      * Purpose:
  133.      *     Call this method to get the text description of a HXR error code.
  134.      * Parameters:
  135.      *     HX_RESULT ulHXCode (A HXR error code)
  136.      *  Return Value:
  137.      *     IHXBuffer* containing error text.
  138.      */
  139.     STDMETHOD_(IHXBuffer*, GetErrorText) (THIS_
  140. HX_RESULT ulHXCode) PURE;
  141. };
  142. /****************************************************************************
  143.  * 
  144.  *  Interface:
  145.  * 
  146.  * IHXErrorSink
  147.  * 
  148.  *  Purpose:
  149.  * 
  150.  * Error Sink Interface
  151.  * 
  152.  *  IID_IHXErrorSink:
  153.  * 
  154.  * {00000801-0901-11d1-8B06-00A024406D59}
  155.  * 
  156.  */
  157. DEFINE_GUID(IID_IHXErrorSink, 0x00000801, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  158. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  159. #undef  INTERFACE
  160. #define INTERFACE   IHXErrorSink
  161. DECLARE_INTERFACE_(IHXErrorSink, IUnknown)
  162. {
  163.     /*
  164.      *  IUnknown methods
  165.      */
  166.     STDMETHOD(QueryInterface) (THIS_
  167. REFIID riid,
  168. void** ppvObj) PURE;
  169.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  170.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  171.     /*
  172.      *  IHXErrorSink methods
  173.      */
  174.     /************************************************************************
  175.      * Method:
  176.      *     IHXErrorSink::ErrorOccurred
  177.      * Purpose:
  178.      *     After you have registered your error sink with an
  179.      *     IHXErrorSinkControl (either in the server or player core) this
  180.      *     method will be called to report an error, event, or status message.
  181.      *
  182.      *     The meaning of the arguments is exactly as described in
  183.      *     hxerror.h
  184.      */
  185.     STDMETHOD(ErrorOccurred) (THIS_
  186. const UINT8 unSeverity,  
  187. const ULONG32 ulHXCode,
  188. const ULONG32 ulUserCode,
  189. const char* pUserString,
  190. const char* pMoreInfoURL
  191. ) PURE;
  192. };
  193. /****************************************************************************
  194.  * 
  195.  *  Interface:
  196.  * 
  197.  * IHXErrorSinkControl
  198.  * 
  199.  *  Purpose:
  200.  * 
  201.  * Error Sink Control Interface
  202.  * 
  203.  *  IID_IHXErrorSinkControl:
  204.  * 
  205.  * {00000802-0901-11d1-8B06-00A024406D59}
  206.  * 
  207.  */
  208. DEFINE_GUID(IID_IHXErrorSinkControl, 0x00000802, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  209. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  210. #undef  INTERFACE
  211. #define INTERFACE   IHXErrorSinkControl
  212. DECLARE_INTERFACE_(IHXErrorSinkControl, IUnknown)
  213. {
  214.     /*
  215.      *  IUnknown methods
  216.      */
  217.     STDMETHOD(QueryInterface) (THIS_
  218. REFIID riid,
  219. void** ppvObj) PURE;
  220.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  221.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  222.     /*
  223.      *  IHXErrorSinkControl methods
  224.      */
  225.     /************************************************************************
  226.      * Method:
  227.      *     IHXErrorSinkControl::AddErrorSink
  228.      * Purpose:
  229.      *     Call this method to tell the sink controller to handle an error
  230.      *     sink.
  231.      *
  232.      *     This method also allows you to set a range of severity levels which
  233.      *     you will receive reports for.
  234.      *
  235.      *      Note: You should specify an invalid range (Low = 1, High = 0 for
  236.      *            example) if you don't want to receive any errors.
  237.      *
  238.      *     The default severity range is HXLOG_EMERG to HXLOG_INFO (0-6).
  239.      */
  240.     STDMETHOD(AddErrorSink) (THIS_
  241. IHXErrorSink* pErrorSink,
  242.                                 const UINT8     unLowSeverity,
  243.                                 const UINT8     unHighSeverity) PURE;
  244.     /************************************************************************
  245.      * Method:
  246.      *     IHXErrorSinkControl::AddErrorSink
  247.      * Purpose:
  248.      *     Call this method to remove an error sink.
  249.      */
  250.     STDMETHOD(RemoveErrorSink) (THIS_
  251. IHXErrorSink* pErrorSink) PURE;
  252. };
  253. #endif /* _HXERROR_H_ */