Description

Describe the details about RDK debug APIs specifications.

void	rdk_dbgDumpLog (const char *path)
	Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect. More...

void	rdk_dbgInit ()
	Initialize the underlying MPEOS debug support. This API must be called only once per boot cycle. More...

rdk_Error	rdk_logger_init (const char *debugConfigFile)
	Initialize the logger. Sets up the environment variable storage by parsing debug configuration file then Initialize the debug support to the underlying platform. More...

rdk_Error	rdk_logger_deinit ()
	Cleanup the logger instantiation. More...

void	rdk_dbg_MsgRaw (rdk_LogLevel level, const char module, const char format,...) __attribute__((format(printf
	Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect. More...

void void	rdk_dbg_MsgRaw1 (rdk_LogLevel level, const char module, const char format, va_list args)
	Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect. More...

rdk_logger_Bool	rdk_dbg_enabled (const char *module, rdk_LogLevel level)
	Function to check if a specific log level of a module is enabled. More...

void	rdk_log_onboard (const char module, const char msg,...) __attribute__((format(printf
	Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect. More...

Function Documentation

◆ rdk_dbgDumpLog()

void rdk_dbgDumpLog ( const char * path )

Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect.

Parameters

[in] path Character string representing path of the temp file to be created.

Returns: None.

Definition at line 67 of file rdk_debug.c.

◆ rdk_dbgInit()

void rdk_dbgInit ( )

Initialize the underlying MPEOS debug support. This API must be called only once per boot cycle.

Returns: None.

Definition at line 100 of file rdk_debug.c.

◆ rdk_logger_init()

rdk_Error rdk_logger_init ( const char * debugConfigFile )

Initialize the logger. Sets up the environment variable storage by parsing debug configuration file then Initialize the debug support to the underlying platform.

Note: Requests not to send SIGPIPE on errors on stream oriented sockets when the other end breaks the connection. The EPIPE error is still returned.

Parameters

[in] debugConfigFile The character pointer variable of debug configuration file.

Returns: Returns 0 if initialization of RDK logger module is successful, else it returns -1.

Definition at line 57 of file rdk_logger_init.c.

◆ rdk_logger_deinit()

rdk_Error rdk_logger_deinit ( )

Cleanup the logger instantiation.

Returns: Returns 0 if the call is successful else return -1.

Definition at line 108 of file rdk_logger_init.c.

◆ rdk_dbg_MsgRaw()

void rdk_dbg_MsgRaw	(	rdk_LogLevel	level,
		const char *	module,
		const char *	format,
			...
	)

Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect.

Parameters

[in] path Character string representing path of the temp file to be created.

Returns: None.

◆ rdk_dbg_MsgRaw1()

void void rdk_dbg_MsgRaw1	(	rdk_LogLevel	level,
		const char *	module,
		const char *	format,
		va_list	args
	)

Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect.

Parameters

[in] path Character string representing path of the temp file to be created.

Returns: None.

Definition at line 139 of file rdk_debug.c.

◆ rdk_dbg_enabled()

rdk_logger_Bool rdk_dbg_enabled	(	const char *	module,
		rdk_LogLevel	level
	)

Function to check if a specific log level of a module is enabled.

Parameters

[in]	module	The module name or category for for which the log level shall be checked (as mentioned in debug.ini).
[in]	level	The debug logging level.

Returns: Returns true, if debug log level enabled successfully else returns false.

Definition at line 415 of file rdk_debug_priv.c.

◆ rdk_log_onboard()

void rdk_log_onboard	(	const char *	module,
		const char *	msg,
			...
	)

Dump the debug log. It will Dump all the current settings so that an analysis of a log file will include what logging information to expect.

Parameters

[in] path Character string representing path of the temp file to be created.

Returns: None.