Logging

Controlling the libsigrokdecode message logging functionality. More...

Functions
int	srd_log_loglevel_set (int loglevel)
	Set the libsigrokdecode loglevel. More...
int	srd_log_loglevel_get (void)
	Get the libsigrokdecode loglevel. More...
int	srd_log_callback_set (srd_log_callback cb, void *cb_data)
	Set the libsigrokdecode log callback to the specified function. More...
int	srd_log_callback_set_default (void)
	Set the libsigrokdecode log callback to the default built-in one. More...

Detailed Description

Controlling the libsigrokdecode message logging functionality.

Function Documentation

int srd_log_callback_set	(	srd_log_callback	cb,
		void *	cb_data
	)

Set the libsigrokdecode log callback to the specified function.

Parameters

cb	Function pointer to the log callback function to use. Must not be NULL.
cb_data	Pointer to private data to be passed on. This can be used by the caller to pass arbitrary data to the log functions. This pointer is only stored or passed on by libsigrokdecode, and is never used or interpreted in any way. The pointer is allowed to be NULL if the caller doesn't need/want to pass any data.

Returns

SRD_OK upon success, SRD_ERR_ARG upon invalid arguments.

Since

0.3.0

Definition at line 118 of file log.c.

References SRD_ERR_ARG, and SRD_OK.

int srd_log_callback_set_default

(

void

)

Set the libsigrokdecode log callback to the default built-in one.

Additionally, the internal 'srd_log_cb_data' pointer is set to NULL.

Returns

SRD_OK upon success, a (negative) error code otherwise.

Since

0.1.0

Definition at line 142 of file log.c.

References SRD_OK.

int srd_log_loglevel_get

(

void

)

Get the libsigrokdecode loglevel.

Returns

The currently configured libsigrokdecode loglevel.

Since

0.1.0

Definition at line 97 of file log.c.

int srd_log_loglevel_set

(

int

loglevel

)

Set the libsigrokdecode loglevel.

This influences the amount of log messages (debug messages, error messages, and so on) libsigrokdecode will output. Using SRD_LOG_NONE disables all messages.

Note that this function itself will also output log messages. After the loglevel has changed, it will output a debug message with SRD_LOG_DBG for example. Whether this message is shown depends on the (new) loglevel.

Parameters

loglevel

The loglevel to set (SRD_LOG_NONE, SRD_LOG_ERR, SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW).

Returns

SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel.

Since

0.1.0

Definition at line 76 of file log.c.

References SRD_ERR_ARG, SRD_LOG_SPEW, and SRD_OK.