#include "ThreadPool.h"
#include "upnpconfig.h"
#include "UpnpGlobal.h"
#include <stdio.h>

Include dependency graph for upnpdebug.h:

This graph shows which files directly or indirectly include this file:

Defines
#define	UPNP_DEFAULT_LOG_LEVEL UPNP_ALL
Functions
int	UpnpInitLog (void)
	Initialize the log files.
void	UpnpSetLogLevel (Upnp_LogLevel log_level)
	Set the log level (see `Upnp_LogLevel`).
void	UpnpCloseLog (void)
	Closes the log files.
void	UpnpSetLogFileNames (const char ErrFileName, const char InfoFileName)
	Set the name for error and information files, respectively.
FILE *	UpnpGetDebugFile (Upnp_LogLevel level, Dbg_Module module)
	Check if the module is turned on for debug and returns the file descriptor corresponding to the debug level.
int	DebugAtThisLevel (Upnp_LogLevel DLevel, Dbg_Module Module)
	Returns true if debug output should be done in this module.
void	UpnpPrintf (Upnp_LogLevel DLevel, Dbg_Module Module, const char DbgFileName, int DbgLineNo, const char FmtStr,...)
	Prints the debug statement either on the standard output or log file along with the information from where this debug statement is coming.
void	UpnpDisplayFileAndLine (FILE fd, const char DbgFileName, int DbgLineNo)
	Writes the file name and file number from where debug statement is coming to the log file.
void	UpnpDisplayBanner (FILE fd, const char *lines, size_t size, int starlength)
	Writes the buffer in the file as per the requested banner.
void	PrintThreadPoolStats (ThreadPool tp, const char DbgFileName, int DbgLineNo, const char *msg)
	Prints thread pool statistics.
Upnp_LogLevel
The user has the option to select 4 different types of debugging levels, see `UpnpSetLogLevel`. The critical level will show only those messages which can halt the normal processing of the library, like memory allocation errors. The remaining three levels are just for debugging purposes. Packet level will display all the incoming and outgoing packets that are flowing between the control point and the device. Info Level displays the other important operational information regarding the working of the library. If the user selects All, then the library displays all the debugging information that it has. `UPNP_CRITICAL` [0] `UPNP_PACKET` [1] `UPNP_INFO` [2] `UPNP_ALL` [3]
enum	Upnp_Module { SSDP, SOAP, GENA, TPOOL, MSERV, DOM, API, HTTP }
enum	Upnp_LogLevel_e { UPNP_CRITICAL, UPNP_PACKET, UPNP_INFO, UPNP_ALL }
typedef enum Upnp_Module	Dbg_Module
typedef enum Upnp_LogLevel_e	Upnp_LogLevel

Detailed Description

Define Documentation

#define UPNP_DEFAULT_LOG_LEVEL UPNP_ALL

Default log level : see Upnp_LogLevel

Function Documentation

int DebugAtThisLevel	(	Upnp_LogLevel	DLevel,
		Dbg_Module	Module
	)

Returns true if debug output should be done in this module.

Returns:: Nonzero value if true, zero if false.

Parameters:

`[in]`	DLevel	The level of the debug logging. It will decide whether debug statement will go to standard output, or any of the log files.
`[in]`	Module	Debug will go in the name of this module.

References DebugAtThisLevel().

Referenced by DebugAtThisLevel(), UpnpGetDebugFile(), and UpnpPrintf().

void PrintThreadPoolStats	(	ThreadPool *	tp,
		const char *	DbgFileName,
		int	DbgLineNo,
		const char *	msg
	)

Prints thread pool statistics.

Parameters:

`[in]`	tp	The thread pool.
`[in]`	DbgFileName	The file name that called this function, use the macro __FILE__.
`[in]`	DbgLineNo	The line number that the function was called, use the macro __LINE__.
`[in]`	msg	The message.

References PrintThreadPoolStats(), and UpnpPrintf().

Referenced by PrintThreadPoolStats(), and UpnpFinish().

void UpnpCloseLog ( void )

Closes the log files.

References UpnpCloseLog().

Referenced by UpnpCloseLog(), and UpnpFinish().

void UpnpDisplayBanner	(	FILE *	fd,
		const char **	lines,
		size_t	size,
		int	starlength
	)

Writes the buffer in the file as per the requested banner.

Parameters:

`[in]`	fd	file descriptor where the banner will be written.
`[in]`	lines	The buffer that will be written.
`[in]`	size	Size of the buffer.
`[in]`	starlength	This parameter provides the width of the banner.

void UpnpDisplayFileAndLine	(	FILE *	fd,
		const char *	DbgFileName,
		int	DbgLineNo
	)

Writes the file name and file number from where debug statement is coming to the log file.

Parameters:

`[in]`	fd	File descriptor where line number and file name will be written.
`[in]`	DbgFileName	Name of the file.
`[in]`	DbgLineNo	Line number of the file.

References UpnpDisplayFileAndLine().

Referenced by UpnpDisplayFileAndLine(), and UpnpPrintf().

FILE* UpnpGetDebugFile	(	Upnp_LogLevel	level,
		Dbg_Module	module
	)

Check if the module is turned on for debug and returns the file descriptor corresponding to the debug level.

Returns:: NULL if the module is turn off for debug otheriwse returns the right file descriptor.

Parameters:

`[in]`	level	The level of the debug logging. It will decide whether debug statement will go to standard output, or any of the log files.
`[in]`	module	debug will go in the name of this module.

References DebugAtThisLevel(), and UpnpGetDebugFile().

Referenced by UpnpGetDebugFile().

int UpnpInitLog ( void )

Initialize the log files.

Returns:: -1 if fails or UPNP_E_SUCCESS if succeeds.

References UpnpInitLog().

Referenced by UpnpInitLog(), and UpnpInitPreamble().

void UpnpPrintf	(	Upnp_LogLevel	DLevel,
		Dbg_Module	Module,
		const char *	DbgFileName,
		int	DbgLineNo,
		const char *	FmtStr,
			...
	)

Prints the debug statement either on the standard output or log file along with the information from where this debug statement is coming.

Parameters:

`[in]`	DLevel	The level of the debug logging. It will decide whether debug statement will go to standard output, or any of the log files.
`[in]`	Module	debug will go in the name of this module.
`[in]`	DbgFileName	Name of the file from where debug statement is coming.
`[in]`	DbgLineNo	Line number of the file from where debug statement is coming.
`[in]`	FmtStr	Printf like format specification.