The OpenVX Specification  a73e458

Detailed Description

Defines the debug logging interface.

The functions of the debugging interface allow clients to receive important debugging information about OpenVX.

See also
The vx_status Constants for the list of possible errors.

msc_log_callback
Log messages only can be received after the callback is installed.

Typedefs

typedef void(* vx_log_callback_f) (vx_context context, vx_reference ref, vx_status status, vx_char string[])
 The log callback function [R01650].
 

Functions

void VX_API_CALL vxAddLogEntry (vx_reference ref, vx_status status, const char *message,...)
 Adds a line to the log [R00921]. More...
 
void VX_API_CALL vxRegisterLogCallback (vx_context context, vx_log_callback_f callback, vx_bool reentrant)
 Registers a callback facility to the OpenVX implementation to receive error logs [R00928]. More...
 

Function Documentation

◆ vxAddLogEntry()

void VX_API_CALL vxAddLogEntry ( vx_reference  ref,
vx_status  status,
const char *  message,
  ... 
)

Adds a line to the log [R00921].

Parameters
[in]refThe reference to add the log entry against [R00922]. Some valid value must be provided.
[in]statusThe status code [R00923]. VX_SUCCESS status entries are ignored and not added [R00924].
[in]messageThe human readable message to add to the log [R00925].
[in]...a list of variable arguments to the message [R00926].
Note
Messages may not exceed VX_MAX_LOG_MESSAGE_LEN bytes and will be truncated in the log if they exceed this limit [R00927].

◆ vxRegisterLogCallback()

void VX_API_CALL vxRegisterLogCallback ( vx_context  context,
vx_log_callback_f  callback,
vx_bool  reentrant 
)

Registers a callback facility to the OpenVX implementation to receive error logs [R00928].

Parameters
[in]contextThe overall context to OpenVX [R00929].
[in]callbackThe callback function [R00930]. If NULL, the previous callback is removed [R00931].
[in]reentrantIf reentrancy flag is vx_true_e, then the callback may be entered from multiple simultaneous tasks or threads (if the host OS supports this) [R00932].