You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
273 lines
7.4 KiB
273 lines
7.4 KiB
|
|
/*
|
|
*
|
|
* This software is released under the provisions of the GPL version 2.
|
|
* see file "COPYING". If that file is not available, the full statement
|
|
* of the license can be found at
|
|
*
|
|
* http://www.fsf.org/licensing/licenses/gpl.txt
|
|
*
|
|
* Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
|
|
*
|
|
*/
|
|
|
|
#ifndef _HXERROR_H_
|
|
#define _HXERROR_H_
|
|
|
|
/*
|
|
* Forward declarations of some interfaces defined here-in.
|
|
*/
|
|
typedef _INTERFACE IHXBuffer IHXBuffer;
|
|
typedef _INTERFACE IHXErrorSinkControl IHXErrorSinkControl;
|
|
|
|
|
|
/* Message Severity values */
|
|
|
|
enum {
|
|
HXLOG_EMERG = 0, /* A panic condition. Server / Player will halt or
|
|
restart. */
|
|
|
|
HXLOG_ALERT = 1, /* A condition that should be corrected immediately.
|
|
Needs user intervention to prevent problems. */
|
|
|
|
HXLOG_CRIT = 2, /* Critical conditions. */
|
|
|
|
HXLOG_ERR = 3, /* Errors. */
|
|
|
|
HXLOG_WARNING = 4, /* Warning messages. */
|
|
|
|
HXLOG_NOTICE = 5, /* Conditions that are not error conditions, but
|
|
should possibly be handled specially. */
|
|
|
|
HXLOG_INFO = 6, /* Informational messages. */
|
|
|
|
HXLOG_DEBUG = 7 /* Messages that contain information normally of use
|
|
only when debugging a program. */
|
|
};
|
|
|
|
|
|
/****************************************************************************
|
|
*
|
|
* Interface:
|
|
*
|
|
* IHXErrorMessages
|
|
*
|
|
* Purpose:
|
|
*
|
|
* Error, event, and status message reporting interface
|
|
*
|
|
* IID_IHXErrorMessages:
|
|
*
|
|
* {00000800-0901-11d1-8B06-00A024406D59}
|
|
*
|
|
*/
|
|
DEFINE_GUID(IID_IHXErrorMessages, 0x00000800, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
|
|
0xa0, 0x24, 0x40, 0x6d, 0x59);
|
|
|
|
#undef INTERFACE
|
|
#define INTERFACE IHXErrorMessages
|
|
|
|
DECLARE_INTERFACE_(IHXErrorMessages, IUnknown)
|
|
{
|
|
/*
|
|
* IUnknown methods
|
|
*/
|
|
STDTQT_METHOD(QueryInterface) (THIS_
|
|
REFIID riid,
|
|
void** ppvObj) PURE;
|
|
|
|
STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
|
|
|
|
STDMETHOD_(ULONG32,Release) (THIS) PURE;
|
|
|
|
/*
|
|
* IHXErrorMessages methods
|
|
*/
|
|
|
|
/************************************************************************
|
|
* Method:
|
|
* IHXErrorMessages::Report
|
|
* Purpose:
|
|
* Call this method to report an error, event, or status message.
|
|
* Parameters:
|
|
*
|
|
* const UINT8 unSeverity
|
|
* Type of report. This value will impact how the player, tool, or
|
|
* server will react to the report. Possible values are described
|
|
* above. Depending on the error type, an error message with the
|
|
* HXR code, anda string translation of that code will be displayed.
|
|
* The error dialog includes a "more info" section that displays the
|
|
* user code and string, and a link to the more info URL. In the
|
|
* server these messages are logged to the log file.
|
|
*
|
|
* const ULONG32 ulHXCode
|
|
* Well known HXR error code. This will be translated to a text
|
|
* representation for display in an error dialog box or log file.
|
|
*
|
|
* const ULONG32 ulUserCode
|
|
* User specific error code. This will NOT be translated to a text
|
|
* representation. This can be any value the caller wants, it will
|
|
* be logged or displayed but not interpretted.
|
|
*
|
|
* const char* pUserString
|
|
* User specific error string. This will NOT be translated or
|
|
* modified. This can be any value the caller wants, it will
|
|
* be logged or displayed but not interpretted.
|
|
*
|
|
* const char* pMoreInfoURL
|
|
* User specific more info URL string.
|
|
*
|
|
*/
|
|
STDTQT_METHOD(Report) (THIS_
|
|
const UINT8 unSeverity,
|
|
HX_RESULT ulHXCode,
|
|
const ULONG32 ulUserCode,
|
|
const char* pUserString,
|
|
const char* pMoreInfoURL) PURE;
|
|
|
|
/************************************************************************
|
|
* Method:
|
|
* IHXErrorMessages::GetErrorText
|
|
* Purpose:
|
|
* Call this method to get the text description of a HXR error code.
|
|
* Parameters:
|
|
* HX_RESULT ulHXCode (A HXR error code)
|
|
* Return Value:
|
|
* IHXBuffer* containing error text.
|
|
*/
|
|
STDMETHOD_(IHXBuffer*, GetErrorText) (THIS_
|
|
HX_RESULT ulHXCode) PURE;
|
|
};
|
|
|
|
|
|
/****************************************************************************
|
|
*
|
|
* Interface:
|
|
*
|
|
* IHXErrorSink
|
|
*
|
|
* Purpose:
|
|
*
|
|
* Error Sink Interface
|
|
*
|
|
* IID_IHXErrorSink:
|
|
*
|
|
* {00000801-0901-11d1-8B06-00A024406D59}
|
|
*
|
|
*/
|
|
DEFINE_GUID(IID_IHXErrorSink, 0x00000801, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
|
|
0xa0, 0x24, 0x40, 0x6d, 0x59);
|
|
|
|
#undef INTERFACE
|
|
#define INTERFACE IHXErrorSink
|
|
|
|
DECLARE_INTERFACE_(IHXErrorSink, IUnknown)
|
|
{
|
|
/*
|
|
* IUnknown methods
|
|
*/
|
|
STDTQT_METHOD(QueryInterface) (THIS_
|
|
REFIID riid,
|
|
void** ppvObj) PURE;
|
|
|
|
STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
|
|
|
|
STDMETHOD_(ULONG32,Release) (THIS) PURE;
|
|
|
|
/*
|
|
* IHXErrorSink methods
|
|
*/
|
|
|
|
/************************************************************************
|
|
* Method:
|
|
* IHXErrorSink::ErrorOccurred
|
|
* Purpose:
|
|
* After you have registered your error sink with an
|
|
* IHXErrorSinkControl (either in the server or player core) this
|
|
* method will be called to report an error, event, or status message.
|
|
*
|
|
* The meaning of the arguments is exactly as described in
|
|
* hxerror.h
|
|
*/
|
|
STDTQT_METHOD(ErrorOccurred) (THIS_
|
|
const UINT8 unSeverity,
|
|
const ULONG32 ulHXCode,
|
|
const ULONG32 ulUserCode,
|
|
const char* pUserString,
|
|
const char* pMoreInfoURL
|
|
) PURE;
|
|
};
|
|
|
|
|
|
/****************************************************************************
|
|
*
|
|
* Interface:
|
|
*
|
|
* IHXErrorSinkControl
|
|
*
|
|
* Purpose:
|
|
*
|
|
* Error Sink Control Interface
|
|
*
|
|
* IID_IHXErrorSinkControl:
|
|
*
|
|
* {00000802-0901-11d1-8B06-00A024406D59}
|
|
*
|
|
*/
|
|
DEFINE_GUID(IID_IHXErrorSinkControl, 0x00000802, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
|
|
0xa0, 0x24, 0x40, 0x6d, 0x59);
|
|
|
|
#undef INTERFACE
|
|
#define INTERFACE IHXErrorSinkControl
|
|
|
|
|
|
DECLARE_INTERFACE_(IHXErrorSinkControl, IUnknown)
|
|
{
|
|
/*
|
|
* IUnknown methods
|
|
*/
|
|
STDTQT_METHOD(QueryInterface) (THIS_
|
|
REFIID riid,
|
|
void** ppvObj) PURE;
|
|
|
|
STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
|
|
|
|
STDMETHOD_(ULONG32,Release) (THIS) PURE;
|
|
|
|
/*
|
|
* IHXErrorSinkControl methods
|
|
*/
|
|
|
|
/************************************************************************
|
|
* Method:
|
|
* IHXErrorSinkControl::AddErrorSink
|
|
* Purpose:
|
|
* Call this method to tell the sink controller to handle an error
|
|
* sink.
|
|
*
|
|
* This method also allows you to set a range of severity levels which
|
|
* you will receive reports for.
|
|
*
|
|
* Note: You should specify an invalid range (Low = 1, High = 0 for
|
|
* example) if you don't want to receive any errors.
|
|
*
|
|
* The default severity range is HXLOG_EMERG to HXLOG_INFO (0-6).
|
|
*/
|
|
STDTQT_METHOD(AddErrorSink) (THIS_
|
|
IHXErrorSink* pErrorSink,
|
|
const UINT8 unLowSeverity,
|
|
const UINT8 unHighSeverity) PURE;
|
|
|
|
/************************************************************************
|
|
* Method:
|
|
* IHXErrorSinkControl::AddErrorSink
|
|
* Purpose:
|
|
* Call this method to remove an error sink.
|
|
*/
|
|
STDTQT_METHOD(RemoveErrorSink) (THIS_
|
|
IHXErrorSink* pErrorSink) PURE;
|
|
|
|
};
|
|
|
|
#endif /* _HXERROR_H_ */
|