libsigrok
Defines | Functions
log.c File Reference
#include <stdarg.h>
#include <stdio.h>
#include "sigrok.h"
#include "sigrok-internal.h"
Include dependency graph for log.c:

Go to the source code of this file.

Defines

#define LOGDOMAIN_MAXLEN   30
#define LOGDOMAIN_DEFAULT   "sr: "

Functions

SR_API int sr_log_loglevel_set (int loglevel)
 Set the libsigrok loglevel.
SR_API int sr_log_loglevel_get (void)
 Get the libsigrok loglevel.
SR_API int sr_log_logdomain_set (const char *logdomain)
 Set the libsigrok logdomain string.
SR_API char * sr_log_logdomain_get (void)
 Get the currently configured libsigrok logdomain.
SR_API int sr_log_callback_set (sr_log_callback_t cb, void *cb_data)
 Set the libsigrok log callback to the specified function.
SR_API int sr_log_callback_set_default (void)
 Set the libsigrok log callback to the default built-in one.
SR_PRIV int sr_log (int loglevel, const char *format,...)
SR_PRIV int sr_spew (const char *format,...)
SR_PRIV int sr_dbg (const char *format,...)
SR_PRIV int sr_info (const char *format,...)
SR_PRIV int sr_warn (const char *format,...)
SR_PRIV int sr_err (const char *format,...)

Define Documentation

#define LOGDOMAIN_DEFAULT   "sr: "

Definition at line 44 of file log.c.

#define LOGDOMAIN_MAXLEN   30

Definition at line 43 of file log.c.

Referenced by sr_log_logdomain_set().


Function Documentation

SR_PRIV int sr_dbg ( const char *  format,
  ... 
)
SR_PRIV int sr_err ( const char *  format,
  ... 
)
SR_PRIV int sr_info ( const char *  format,
  ... 
)
SR_PRIV int sr_log ( int  loglevel,
const char *  format,
  ... 
)

Definition at line 193 of file log.c.

SR_API int sr_log_callback_set ( sr_log_callback_t  cb,
void *  cb_data 
)

Set the libsigrok log callback to the specified function.

Parameters:
cbFunction pointer to the log callback function to use. Must not be NULL.
cb_dataPointer 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 libsigrok, 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:
SR_OK upon success, SR_ERR_ARG upon invalid arguments.

Definition at line 140 of file log.c.

References sr_err(), SR_ERR_ARG, and SR_OK.

Here is the call graph for this function:

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

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

Returns:
SR_OK upon success, a negative error code otherwise.

Definition at line 162 of file log.c.

References SR_OK.

SR_API char* sr_log_logdomain_get ( void  )

Get the currently configured libsigrok logdomain.

Returns:
A copy of the currently configured libsigrok logdomain string. The caller is responsible for g_free()ing the string when it is no longer needed.

Definition at line 122 of file log.c.

SR_API int sr_log_logdomain_set ( const char *  logdomain)

Set the libsigrok logdomain string.

Parameters:
logdomainThe string to use as logdomain for libsigrok log messages from now on. Must not be NULL. The maximum length of the string is 30 characters (this does not include the trailing NUL-byte). Longer strings are silently truncated. In order to not use a logdomain, pass an empty string. The function makes its own copy of the input string, i.e. the caller does not need to keep it around.
Returns:
SR_OK upon success, SR_ERR_ARG upon invalid logdomain.

Definition at line 100 of file log.c.

References LOGDOMAIN_MAXLEN, sr_dbg(), sr_err(), SR_ERR_ARG, and SR_OK.

Here is the call graph for this function:

SR_API int sr_log_loglevel_get ( void  )

Get the libsigrok loglevel.

Returns:
The currently configured libsigrok loglevel.

Definition at line 81 of file log.c.

Referenced by sr_session_send().

SR_API int sr_log_loglevel_set ( int  loglevel)

Set the libsigrok loglevel.

This influences the amount of log messages (debug messages, error messages, and so on) libsigrok will output. Using SR_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 SR_LOG_DBG for example. Whether this message is shown depends on the (new) loglevel.

Parameters:
loglevelThe loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN, SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW).
Returns:
SR_OK upon success, SR_ERR_ARG upon invalid loglevel.

Definition at line 62 of file log.c.

References sr_dbg(), sr_err(), SR_ERR_ARG, SR_LOG_SPEW, and SR_OK.

Here is the call graph for this function:

SR_PRIV int sr_spew ( const char *  format,
  ... 
)

Definition at line 205 of file log.c.

References SR_LOG_SPEW.

Referenced by sr_dev_has_hwcap().

SR_PRIV int sr_warn ( const char *  format,
  ... 
)

Definition at line 241 of file log.c.

References SR_LOG_WARN.

Referenced by sr_dev_inst_get(), and sr_driver_init().

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines