API for logging support. More...

Collaboration diagram for Logging Support:

Macros
#define	COAP_DEBUG_FD stdout
	Used for output for `LOG_DEBUG` to `LOG_ERR`. More...

#define	COAP_ERR_FD stderr
	Used for output for `LOG_CRIT` to `LOG_EMERG`. More...

#define	LOG_EMERG 0

#define	LOG_ALERT 1

#define	LOG_CRIT 2

#define	LOG_ERR 3

#define	LOG_WARNING 4

#define	LOG_NOTICE 5

#define	LOG_INFO 6

#define	LOG_DEBUG 7

#define	COAP_LOG_CIPHERS (LOG_DEBUG+2)

#define	coap_log(level, ...)
	Logging function. More...

Typedefs
typedef int	coap_log_t
	Logging type. More...

typedef void(*	coap_log_handler_t) (coap_log_t level, const char *message)
	Logging callback handler definition. More...

Functions
coap_log_t	coap_get_log_level (void)
	Get the current logging level. More...

void	coap_set_log_level (coap_log_t level)
	Sets the log level to the specified value. More...

void	coap_set_log_handler (coap_log_handler_t handler)
	Add a custom log callback handler. More...

const char *	coap_package_name (void)
	Get the library package name. More...

const char *	coap_package_version (void)
	Get the library package version. More...

const char *	coap_package_build (void)
	Get the library package build. More...

void	coap_log_impl (coap_log_t level, const char *format,...)
	Writes the given text to `COAP_ERR_FD` (for `level` <= `LOG_CRIT`) or `COAP_DEBUG_FD` (for `level` >= `LOG_ERR`). More...

void	coap_set_show_pdu_output (int use_fprintf)
	Defines the output mode for the coap_show_pdu() function. More...

void	coap_show_pdu (coap_log_t level, const coap_pdu_t *pdu)
	Display the contents of the specified `pdu`. More...

void	coap_show_tls_version (coap_log_t level)
	Display the current (D)TLS library linked with and built for version. More...

char *	coap_string_tls_version (char *buffer, size_t bufsize)
	Build a string containing the current (D)TLS library linked with and built for version. More...

char *	coap_string_tls_support (char *buffer, size_t bufsize)
	Build a string containing the current (D)TLS library support. More...

size_t	coap_print_addr (const coap_address_t address, unsigned char buffer, size_t size)
	Print the address into the defined buffer. More...

void	coap_dtls_set_log_level (int level)
	Sets the (D)TLS logging level to the specified `level`. More...

int	coap_dtls_get_log_level (void)
	Get the current (D)TLS logging. More...

const char *	coap_session_str (const coap_session_t *session)
	Get session description. More...

const char *	coap_endpoint_str (const coap_endpoint_t *endpoint)
	Get endpoint description. More...

Detailed Description

API for logging support.

Macro Definition Documentation

◆ COAP_DEBUG_FD

#define COAP_DEBUG_FD stdout

Used for output for LOG_DEBUG to LOG_ERR.

Definition at line 31 of file coap_debug.h.

◆ COAP_ERR_FD

#define COAP_ERR_FD stderr

Used for output for LOG_CRIT to LOG_EMERG.

Definition at line 38 of file coap_debug.h.

◆ coap_log

#define coap_log	(	level,
		...
	)

Value:

  do { \
  if ((int)((level))<=(int)coap_get_log_level()) \
     coap_log_impl((level), __VA_ARGS__); \
} while(0)

Logging function.

Writes the given text to COAP_ERR_FD (for level <= LOG_CRIT) or COAP_DEBUG_FD (for level >= LOG_ERR). The text is output only when level is below or equal to the log level that set by coap_set_log_level().

Parameters

level One of the LOG_* values.

Definition at line 165 of file coap_debug.h.

◆ COAP_LOG_CIPHERS

#define COAP_LOG_CIPHERS (LOG_DEBUG+2)

Definition at line 87 of file coap_debug.h.

◆ LOG_ALERT

#define LOG_ALERT 1

Definition at line 63 of file coap_debug.h.

◆ LOG_CRIT

#define LOG_CRIT 2

Definition at line 66 of file coap_debug.h.

◆ LOG_DEBUG

#define LOG_DEBUG 7

Definition at line 81 of file coap_debug.h.

◆ LOG_EMERG

#define LOG_EMERG 0

Definition at line 60 of file coap_debug.h.

◆ LOG_ERR

#define LOG_ERR 3

Definition at line 69 of file coap_debug.h.

◆ LOG_INFO

#define LOG_INFO 6

Definition at line 78 of file coap_debug.h.

◆ LOG_NOTICE

#define LOG_NOTICE 5

Definition at line 75 of file coap_debug.h.

◆ LOG_WARNING

#define LOG_WARNING 4

Definition at line 72 of file coap_debug.h.

Typedef Documentation

◆ coap_log_handler_t

typedef void(* coap_log_handler_t) (coap_log_t level, const char *message)

Logging callback handler definition.

Parameters

level	One of the LOG_* values.
message	Zero-terminated string message to log.

Definition at line 109 of file coap_debug.h.

◆ coap_log_t

typedef int coap_log_t

Logging type.

One of LOG_* from syslog.

Definition at line 44 of file coap_debug.h.

Function Documentation

◆ coap_dtls_get_log_level()

int coap_dtls_get_log_level ( void )

Get the current (D)TLS logging.

Returns: The current log level (one of LOG_*).

Definition at line 102 of file coap_notls.c.

◆ coap_dtls_set_log_level()

void coap_dtls_set_log_level ( int level )

Sets the (D)TLS logging level to the specified level.

Note: coap_log_level() will influence output if at a specified level.

Parameters

level The logging level to use - LOG_*

Definition at line 97 of file coap_notls.c.

◆ coap_endpoint_str()

const char * coap_endpoint_str ( const coap_endpoint_t * endpoint )

Get endpoint description.

Parameters

endpoint The CoAP endpoint.

Returns: description string.

◆ coap_get_log_level()

coap_log_t coap_get_log_level ( void )

Get the current logging level.

Returns: One of the LOG_* values.

Definition at line 76 of file coap_debug.c.

Here is the caller graph for this function:

◆ coap_log_impl()

void coap_log_impl	(	coap_log_t	level,
		const char *	format,
			...
	)

Writes the given text to COAP_ERR_FD (for level <= LOG_CRIT) or COAP_DEBUG_FD (for level >= LOG_ERR).

The text is output only when level is below or equal to the log level that set by coap_set_log_level().

Internal function.

Parameters

level	One of the LOG_* values. &
format	The format string to use.

Definition at line 935 of file coap_debug.c.

Here is the call graph for this function:

◆ coap_package_build()

const char * coap_package_build ( void )

Get the library package build.

Returns: Zero-terminated string with the library build.

Definition at line 62 of file coap_debug.c.

◆ coap_package_name()

const char * coap_package_name ( void )

Get the library package name.

Returns: Zero-terminated string with the name of this library.

Definition at line 54 of file coap_debug.c.

◆ coap_package_version()

const char * coap_package_version ( void )

Get the library package version.

Returns: Zero-terminated string with the library version.

Definition at line 58 of file coap_debug.c.

◆ coap_print_addr()

size_t coap_print_addr	(	const coap_address_t *	address,
		unsigned char *	buffer,
		size_t	size
	)

Print the address into the defined buffer.

Internal Function.

Parameters

address	The address to print.
buffer	The buffer to print into.
size	The size of the buffer to print into.

Returns: The amount written into the buffer.

Definition at line 186 of file coap_debug.c.

Here is the caller graph for this function:

◆ coap_session_str()

const char * coap_session_str ( const coap_session_t * session )

Get session description.

Parameters

session The CoAP session.

Returns: description string.

Definition at line 1642 of file coap_session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_set_log_handler()

void coap_set_log_handler ( coap_log_handler_t handler )

Add a custom log callback handler.

Parameters

handler The logging handler to use or NULL to use default handler.

Definition at line 930 of file coap_debug.c.

◆ coap_set_log_level()

void coap_set_log_level ( coap_log_t level )

Sets the log level to the specified value.

Parameters

level One of the LOG_* values.

Definition at line 81 of file coap_debug.c.

◆ coap_set_show_pdu_output()

void coap_set_show_pdu_output ( int use_fprintf )

Defines the output mode for the coap_show_pdu() function.

Parameters

use_fprintf 1 if the output is to use fprintf() (the default) 0 if the output is to use coap_log().

Definition at line 71 of file coap_debug.c.

◆ coap_show_pdu()

void coap_show_pdu	(	coap_log_t	level,
		const coap_pdu_t *	pdu
	)

Display the contents of the specified pdu.

Note: The output method of coap_show_pdu() is dependent on the setting of coap_set_show_pdu_output().

Parameters

level	The required minimum logging level.
pdu	The PDU to decode.

Definition at line 523 of file coap_debug.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coap_show_tls_version()

void coap_show_tls_version ( coap_log_t level )

Display the current (D)TLS library linked with and built for version.

Parameters

level The required minimum logging level.

Definition at line 778 of file coap_debug.c.

Here is the call graph for this function:

◆ coap_string_tls_support()

char * coap_string_tls_support	(	char *	buffer,
		size_t	bufsize
	)

Build a string containing the current (D)TLS library support.

Parameters

buffer	The buffer to put the string into.
bufsize	The size of the buffer to put the string into.

Returns: A pointer to the provided buffer.

Definition at line 877 of file coap_debug.c.

Here is the call graph for this function:

◆ coap_string_tls_version()

char * coap_string_tls_version	(	char *	buffer,
		size_t	bufsize
	)

Build a string containing the current (D)TLS library linked with and built for version.

Parameters

buffer	The buffer to put the string into.
bufsize	The size of the buffer to put the string into.

Returns: A pointer to the provided buffer.

Definition at line 785 of file coap_debug.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ COAP_DEBUG_FD

◆ COAP_ERR_FD

◆ coap_log

◆ COAP_LOG_CIPHERS

◆ LOG_ALERT

◆ LOG_CRIT

◆ LOG_DEBUG

◆ LOG_EMERG

◆ LOG_ERR

◆ LOG_INFO

◆ LOG_NOTICE

◆ LOG_WARNING

Typedef Documentation

◆ coap_log_handler_t

◆ coap_log_t

Function Documentation

◆ coap_dtls_get_log_level()

◆ coap_dtls_set_log_level()

◆ coap_endpoint_str()

◆ coap_get_log_level()

◆ coap_log_impl()

◆ coap_package_build()

◆ coap_package_name()

◆ coap_package_version()

◆ coap_print_addr()

◆ coap_session_str()

◆ coap_set_log_handler()

◆ coap_set_log_level()

◆ coap_set_show_pdu_output()

◆ coap_show_pdu()

◆ coap_show_tls_version()

◆ coap_string_tls_support()

◆ coap_string_tls_version()