The mm-renderer error information.
Synopsis:
struct {
uint32_t error_code ;
char extra_type [20];
int64_t extra_value ;
char extra_text [256];
};
Data:
- uint32_t error_code
- One of the mm_error_code_t constants.
- char extra_type[20]
- A short string identifying the API or protocol that defines the meaning of extra_value, such as "errno", "http", or "mmf".
- int64_t extra_value
- An error number according to extra_type.
- char extra_text[256]
- Free-form text describing the error.
This may or may not have a format formally defined by a specification. For example, when extra_type is "http", this field contains an HTTP server response string.
Library:
libmmrndclient (For the qcc command, use the -l mrndclient option to link against this library)
Description:
The structure mmr_error_info_t contains error information generated by mm-renderer functions. Use the function mmr_error_info() to retrieve error information for a particular context and function call.
This multifield structure allows plugins to return protocol- or API-specific error information in addition to the MMR error code. The extra_type string is a tag that specifies how to interpret the extra_value and extra_text fields.
The values of extra_type currently supported are:
- an empty string (""): extra_value is set to 0, and the extra_text is usually empty, but possibly contains some descriptive text.
- "errno": extra_value is set to an errno value, and extra_text is usually the result of strerror(extra_value), but may contain something more descriptive.
- "mmf": extra_value is an MMF-specific error code (which is not a valid errno), and extra_text is usually empty, but possibly contains something more descriptive.
- "http": extra_value is an HTTP response code, and extra_text is an HTTP server response.
- "libcurl": extra_value is a libcurl error code (but not CURLE_HTTP_RETURNED_ERROR), and extra_text is the corresponding libcurl error message.