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

Symbian

开发平台:

Visual C++

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