coap_debug.h

Go to the documentation of this file.

/*
 * coap_debug.h -- debug utilities
 *
 * Copyright (C) 2010-2011,2014 Olaf Bergmann <bergmann@tzi.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_DEBUG_H_
#define COAP_DEBUG_H_
 
#ifndef COAP_DEBUG_FD
#define COAP_DEBUG_FD stdout
#endif
 
#ifndef COAP_ERR_FD
#define COAP_ERR_FD stderr
#endif
 
#ifdef HAVE_SYSLOG_H
#include <syslog.h>
typedef short coap_log_t;
/*
   LOG_DEBUG+2 gives ciphers in GnuTLS
   Use COAP_LOG_CIPHERS to output Cipher Info in OpenSSL etc.
 */
#define COAP_LOG_CIPHERS (LOG_DEBUG+2)
#else /* !HAVE_SYSLOG_H */
#if !defined(RIOT_VERSION)
typedef enum {
  LOG_EMERG=0, 
  LOG_ALERT,   
  LOG_CRIT,    
  LOG_ERR,     
  LOG_WARNING, 
  LOG_NOTICE,  
  LOG_INFO,    
  LOG_DEBUG,   
  COAP_LOG_CIPHERS=LOG_DEBUG+2 
} coap_log_t;
#else /* RIOT_VERSION */
/* RIOT defines a subset of the syslog levels in log.h with different
 * numeric values. The remaining levels are defined here. Note that
 * output granularity differs from what would be expected when
 * adhering to the syslog levels.
 */
#include <log.h>
typedef short coap_log_t;
#define LOG_EMERG  (0)
#define LOG_ALERT  (1)
#define LOG_CRIT   (2)
#define LOG_ERR    (3)
/*  LOG_WARNING    (4) */
#define LOG_NOTICE (5)
/*  LOG_INFO       (6) */
/*  LOG_DEBUG      (7) */
#define COAP_LOG_CIPHERS (9)
#endif /* RIOT_VERSION */
 
#endif /* !HAVE_SYSLOG_H */
 
coap_log_t coap_get_log_level(void);
 
void coap_set_log_level(coap_log_t level);
 
typedef void (*coap_log_handler_t) (coap_log_t level, const char *message);
 
void coap_set_log_handler(coap_log_handler_t handler);
 
const char *coap_package_name(void);
 
const char *coap_package_version(void);
 
#if (defined(__GNUC__))
void coap_log_impl(coap_log_t level,
              const char *format, ...) __attribute__ ((format(printf, 2, 3)));
#else
void coap_log_impl(coap_log_t level, const char *format, ...);
#endif
 
#ifndef coap_log
#define coap_log(level, ...) do { \
  if ((int)((level))<=(int)coap_get_log_level()) \
     coap_log_impl((level), __VA_ARGS__); \
} while(0)
#endif
 
#include "pdu.h"
 
void coap_set_show_pdu_output(int use_fprintf);
 
void coap_show_pdu(coap_log_t level, const coap_pdu_t *pdu);
 
void coap_show_tls_version(coap_log_t level);
 
char *coap_string_tls_version(char *buffer, size_t bufsize);
 
char *coap_string_tls_support(char *buffer, size_t bufsize);
 
size_t coap_print_addr(const coap_address_t *address,
                       unsigned char *buffer, size_t size);
 
int coap_debug_set_packet_loss(const char *loss_level);
 
int coap_debug_send_packet(void);
 
 
#endif /* COAP_DEBUG_H_ */