libyang  3.1.0
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Logger
Collaboration diagram for Logger:

Modules

 Debug messages groups
 
 Logging options
 

Typedefs

typedef void(* ly_log_clb )(LY_LOG_LEVEL level, const char *msg, const char *data_path, const char *schema_path, uint64_t line)
 Logger callback. More...
 

Enumerations

enum  LY_LOG_LEVEL { LY_LLERR = 0, LY_LLWRN = 1, LY_LLVRB = 2, LY_LLDBG = 3 }
 Verbosity levels of the libyang logger. More...
 
enum  LY_VECODE {
  LYVE_SUCCESS = 0, LYVE_SYNTAX, LYVE_SYNTAX_YANG, LYVE_SYNTAX_YIN,
  LYVE_REFERENCE, LYVE_XPATH, LYVE_SEMANTICS, LYVE_SYNTAX_XML,
  LYVE_SYNTAX_JSON, LYVE_DATA, LYVE_OTHER
}
 libyang's codes of validation error. Whenever ly_errno is set to LY_EVALID, the ly_vecode is also set to the appropriate LY_VECODE value. More...
 

Functions

LIBYANG_API_DECL ly_log_clb ly_get_log_clb (void)
 Get logger callback. More...
 
LIBYANG_API_DECL uint32_t ly_log_dbg_groups (uint32_t dbg_groups)
 Enable specific debugging messages (independent of log level). More...
 
LIBYANG_API_DECL LY_LOG_LEVEL ly_log_level (LY_LOG_LEVEL level)
 Set logger verbosity level. More...
 
LIBYANG_API_DECL uint32_t ly_log_options (uint32_t opts)
 Set logger options. Default is LY_LOLOG | LY_LOSTORE_LAST. More...
 
LIBYANG_API_DECL void ly_set_log_clb (ly_log_clb clb)
 Set logger callback. More...
 
LIBYANG_API_DECL uint32_t * ly_temp_log_options (uint32_t *opts)
 Set temporary thread-safe logger options overwriting those set by ly_log_options(). More...
 

Detailed Description

Publicly visible functions and values of the libyang logger. For more information, see Information Logging.

Typedef Documentation

typedef void(* ly_log_clb)(LY_LOG_LEVEL level, const char *msg, const char *data_path, const char *schema_path, uint64_t line)

Logger callback.

Parameters
[in]levelLog level of the message.
[in]msgMessage.
[in]data_pathOptional data path of the related node.
[in]schema_pathOptional schema path of the related node.
[in]lineOptional related input line.

Definition at line 187 of file log.h.

Enumeration Type Documentation

Verbosity levels of the libyang logger.

Enumerator
LY_LLERR 

Print only error messages.

LY_LLWRN 

Print error and warning messages, default value.

LY_LLVRB 

Besides errors and warnings, print some other verbose messages.

LY_LLDBG 

Print all messages including some development debug messages (be careful, without subsequently calling ly_log_dbg_groups() no debug messages will be printed!).

Definition at line 88 of file log.h.

enum LY_VECODE

libyang's codes of validation error. Whenever ly_errno is set to LY_EVALID, the ly_vecode is also set to the appropriate LY_VECODE value.

Enumerator
LYVE_SUCCESS 

no error

LYVE_SYNTAX 

generic syntax error

LYVE_SYNTAX_YANG 

YANG-related syntax error

LYVE_SYNTAX_YIN 

YIN-related syntax error

LYVE_REFERENCE 

invalid referencing or using an item

LYVE_XPATH 

invalid XPath expression

LYVE_SEMANTICS 

generic semantic error

LYVE_SYNTAX_XML 

XML-related syntax error

LYVE_SYNTAX_JSON 

JSON-related syntax error

LYVE_DATA 

YANG data does not reflect some of the module restrictions

LYVE_OTHER 

Unknown error

Definition at line 267 of file log.h.

Function Documentation

LIBYANG_API_DECL ly_log_clb ly_get_log_clb ( void  )

Get logger callback.

Returns
Logger callback (can be NULL).
LIBYANG_API_DECL uint32_t ly_log_dbg_groups ( uint32_t  dbg_groups)

Enable specific debugging messages (independent of log level).

To get the current value, the function must be called twice resetting the level by the received value. Note: does not have any effect on non-debug (Release) builds

Parameters
[in]dbg_groupsBitfield of enabled debug message groups (see Debug messages groups).
Returns
Previous options bitfield.
LIBYANG_API_DECL LY_LOG_LEVEL ly_log_level ( LY_LOG_LEVEL  level)

Set logger verbosity level.

To get the current value, the function must be called twice resetting the level by the received value.

Parameters
[in]levelVerbosity level.
Returns
Previous verbosity level.
LIBYANG_API_DECL uint32_t ly_log_options ( uint32_t  opts)

Set logger options. Default is LY_LOLOG | LY_LOSTORE_LAST.

To get the current value, the function must be called twice resetting the level by the received value.

Parameters
[in]optsBitfield of Logging options.
Returns
Previous logger options.
LIBYANG_API_DECL void ly_set_log_clb ( ly_log_clb  clb)

Set logger callback.

Parameters
[in]clbLogging callback.
LIBYANG_API_DECL uint32_t* ly_temp_log_options ( uint32_t *  opts)

Set temporary thread-safe logger options overwriting those set by ly_log_options().

Parameters
[in]optsPointer to the temporary Logging options. If NULL, restores the effect of global logger options.
Returns
Previous temporary options.