libwebsockets
Lightweight C library for HTML5 websockets
Data Structures | Macros | Typedefs | Functions
Logging

Data Structures

struct  lws_log_cx
 

Macros

#define LLL_ERR   (1 << 0)
 
#define LLL_WARN   (1 << 1)
 
#define LLL_NOTICE   (1 << 2)
 
#define LLL_INFO   (1 << 3)
 
#define LLL_DEBUG   (1 << 4)
 
#define LLL_PARSER   (1 << 5)
 
#define LLL_HEADER   (1 << 6)
 
#define LLL_EXT   (1 << 7)
 
#define LLL_CLIENT   (1 << 8)
 
#define LLL_LATENCY   (1 << 9)
 
#define LLL_USER   (1 << 10)
 
#define LLL_THREAD   (1 << 11)
 
#define LLL_COUNT   (12) /* set to count of valid flags */
 
#define LLLF_SECRECY_PII   (1 << 16)
 
#define LLLF_SECRECY_BEARER   (1 << 17)
 
#define LLLF_LOG_TIMESTAMP   (1 << 18)
 
#define LLLF_LOG_CONTEXT_AWARE   (1 << 30)
 
#define lwsl_cx(_c, _fil, ...)
 
#define lwsl_vhost(_v, _fil, ...)
 
#define lwsl_wsi(_w, _fil, ...)
 
#define lwsl_ss(_h, _fil, ...)
 
#define lwsl_hexdump_context(_c, _fil, _buf, _len)
 
#define lwsl_hexdump_vhost(_v, _fil, _buf, _len)
 
#define lwsl_hexdump_wsi(_w, _fil, _buf, _len)
 
#define lwsl_hexdump_ss(_h, _fil, _buf, _len)
 
#define _LWS_LINIT   (LLL_ERR | LLL_USER | LLL_WARN | LLL_NOTICE)
 
#define _LWS_LBS   0
 
#define _LWS_LBC   0
 
#define _LWS_ENABLED_LOGS   (((_LWS_LINIT) | (_LWS_LBS)) & ~(_LWS_LBC))
 
#define lwsl_err(...)
 
#define lwsl_warn(...)
 
#define lwsl_notice(...)
 
#define lwsl_info(...)
 
#define lwsl_debug(...)
 
#define lwsl_parser(...)
 
#define lwsl_header(...)
 
#define lwsl_ext(...)
 
#define lwsl_client(...)
 
#define lwsl_latency(...)
 
#define lwsl_thread(...)
 
#define lwsl_user(...)
 
#define lwsl_hexdump_err(...)
 
#define lwsl_hexdump_warn(...)
 
#define lwsl_hexdump_notice(...)
 
#define lwsl_hexdump_info(...)
 
#define lwsl_hexdump_debug(...)
 
#define lwsl_cx_err(_c, ...)
 
#define lwsl_cx_warn(_c, ...)
 
#define lwsl_cx_notice(_c, ...)
 
#define lwsl_cx_info(_c, ...)
 
#define lwsl_cx_debug(_c, ...)
 
#define lwsl_cx_parser(_c, ...)
 
#define lwsl_cx_header(_c, ...)
 
#define lwsl_cx_ext(_c, ...)
 
#define lwsl_cx_client(_c, ...)
 
#define lwsl_cx_latency(_c, ...)
 
#define lwsl_cx_thread(_c, ...)
 
#define lwsl_cx_user(_c, ...)
 
#define lwsl_hexdump_cx_err(_c, ...)
 
#define lwsl_hexdump_cx_warn(_c, ...)
 
#define lwsl_hexdump_cx_notice(_c, ...)
 
#define lwsl_hexdump_cx_info(_c, ...)
 
#define lwsl_hexdump_cx_debug(_c, ...)
 
#define lwsl_vhost_err(_v, ...)
 
#define lwsl_vhost_warn(_v, ...)
 
#define lwsl_vhost_notice(_v, ...)
 
#define lwsl_vhost_info(_v, ...)
 
#define lwsl_vhost_debug(_v, ...)
 
#define lwsl_vhost_parser(_v, ...)
 
#define lwsl_vhost_header(_v, ...)
 
#define lwsl_vhost_ext(_v, ...)
 
#define lwsl_vhost_client(_v, ...)
 
#define lwsl_vhost_latency(_v, ...)
 
#define lwsl_vhost_thread(_v, ...)
 
#define lwsl_vhost_user(_v, ...)
 
#define lwsl_hexdump_vhost_err(_v, ...)
 
#define lwsl_hexdump_vhost_warn(_v, ...)
 
#define lwsl_hexdump_vhost_notice(_v, ...)
 
#define lwsl_hexdump_vhost_info(_v, ...)
 
#define lwsl_hexdump_vhost_debug(_v, ...)
 
#define lwsl_wsi_err(_w, ...)
 
#define lwsl_wsi_warn(_w, ...)
 
#define lwsl_wsi_notice(_w, ...)
 
#define lwsl_wsi_info(_w, ...)
 
#define lwsl_wsi_debug(_w, ...)
 
#define lwsl_wsi_parser(_w, ...)
 
#define lwsl_wsi_header(_w, ...)
 
#define lwsl_wsi_ext(_w, ...)
 
#define lwsl_wsi_client(_w, ...)
 
#define lwsl_wsi_latency(_w, ...)
 
#define lwsl_wsi_thread(_w, ...)
 
#define lwsl_wsi_user(_w, ...)
 
#define lwsl_hexdump_wsi_err(_v, ...)
 
#define lwsl_hexdump_wsi_warn(_v, ...)
 
#define lwsl_hexdump_wsi_notice(_v, ...)
 
#define lwsl_hexdump_wsi_info(_v, ...)
 
#define lwsl_hexdump_wsi_debug(_v, ...)
 
#define lwsl_ss_err(_w, ...)
 
#define lwsl_ss_warn(_w, ...)
 
#define lwsl_ss_notice(_w, ...)
 
#define lwsl_ss_info(_w, ...)
 
#define lwsl_ss_debug(_w, ...)
 
#define lwsl_ss_parser(_w, ...)
 
#define lwsl_ss_header(_w, ...)
 
#define lwsl_ss_ext(_w, ...)
 
#define lwsl_ss_client(_w, ...)
 
#define lwsl_ss_latency(_w, ...)
 
#define lwsl_ss_thread(_w, ...)
 
#define lwsl_ss_user(_w, ...)
 
#define lwsl_hexdump_ss_err(_v, ...)
 
#define lwsl_hexdump_ss_warn(_v, ...)
 
#define lwsl_hexdump_ss_notice(_v, ...)
 
#define lwsl_hexdump_ss_info(_v, ...)
 
#define lwsl_hexdump_ss_debug(_v, ...)
 

Typedefs

typedef void(* lws_log_emit_t) (int level, const char *line)
 
typedef void(* lws_log_emit_cx_t) (struct lws_log_cx *cx, int level, const char *line, size_t len)
 
typedef void(* lws_log_prepend_cx_t) (struct lws_log_cx *cx, void *obj, char **p, char *e)
 
typedef void(* lws_log_use_cx_t) (struct lws_log_cx *cx, int _new)
 
typedef struct lws_log_cx lws_log_cx_t
 

Functions

LWS_VISIBLE LWS_EXTERN int lwsl_timestamp (int level, char *p, size_t len)
 
LWS_VISIBLE LWS_EXTERN void _lws_log (int filter, const char *format,...) LWS_FORMAT(2)
 
LWS_VISIBLE LWS_EXTERN void _lws_logv (int filter, const char *format, va_list vl)
 
LWS_VISIBLE LWS_EXTERN struct lws_log_cx * lwsl_context_get_cx (struct lws_context *cx)
 
LWS_VISIBLE LWS_EXTERN struct lws_log_cx * lwsl_vhost_get_cx (struct lws_vhost *vh)
 
LWS_VISIBLE LWS_EXTERN struct lws_log_cx * lwsl_wsi_get_cx (struct lws *wsi)
 
LWS_VISIBLE LWS_EXTERN void lws_log_emit_cx_file (struct lws_log_cx *cx, int level, const char *line, size_t len)
 
LWS_VISIBLE LWS_EXTERN void lws_log_use_cx_file (struct lws_log_cx *cx, int _new)
 
LWS_VISIBLE LWS_EXTERN void lws_log_prepend_context (struct lws_log_cx *cx, void *obj, char **p, char *e)
 
LWS_VISIBLE LWS_EXTERN void lws_log_prepend_vhost (struct lws_log_cx *cx, void *obj, char **p, char *e)
 
LWS_VISIBLE LWS_EXTERN void lws_log_prepend_wsi (struct lws_log_cx *cx, void *obj, char **p, char *e)
 
LWS_VISIBLE LWS_EXTERN void _lws_log_cx (lws_log_cx_t *cx, lws_log_prepend_cx_t prep, void *obj, int filter, const char *_fun, const char *format,...) LWS_FORMAT(6)
 
LWS_VISIBLE LWS_EXTERN void lwsl_hexdump_level (int level, const void *vbuf, size_t len)
 
LWS_VISIBLE LWS_EXTERN void lwsl_hexdump_level_cx (lws_log_cx_t *cx, lws_log_prepend_cx_t prep, void *obj, int hexdump_level, const void *vbuf, size_t len)
 
LWS_VISIBLE LWS_EXTERN void lwsl_hexdump (const void *buf, size_t len)
 
LWS_VISIBLE LWS_EXTERN void lws_set_log_level (int level, lws_log_emit_t log_emit_function)
 
LWS_VISIBLE LWS_EXTERN void lwsl_emit_syslog (int level, const char *line)
 
LWS_VISIBLE LWS_EXTERN void lwsl_emit_stderr (int level, const char *line)
 
LWS_VISIBLE LWS_EXTERN void lwsl_emit_stderr_notimestamp (int level, const char *line)
 
LWS_VISIBLE LWS_EXTERN int lwsl_visible (int level)
 
LWS_VISIBLE LWS_EXTERN const char * lws_wsi_tag (struct lws *wsi)
 
LWS_VISIBLE LWS_EXTERN void lwsl_refcount_cx (lws_log_cx_t *cx, int _new)
 

Detailed Description

Logging

Lws provides flexible and filterable logging facilities, which can be used inside lws and in user code.

Log categories may be individually filtered bitwise, and directed to built-in sinks for syslog-compatible logging, or a user-defined function.

Traditional logs use a single, processwide logging context. New style log apis (lws_xxx_cx()) can pass the logging context to use in.

Macro Definition Documentation

◆ LLLF_LOG_CONTEXT_AWARE

#define LLLF_LOG_CONTEXT_AWARE   (1 << 30)

#include <include/libwebsockets/lws-logs.h>

set if the context uses an emit function that takes the logctx, auto- applied when setting emit using lws_set_log_level_cx() api

◆ LLLF_LOG_TIMESTAMP

#define LLLF_LOG_TIMESTAMP   (1 << 18)

#include <include/libwebsockets/lws-logs.h>

set to prepend logs with timestamp

◆ LLLF_SECRECY_BEARER

#define LLLF_SECRECY_BEARER   (1 << 17)

#include <include/libwebsockets/lws-logs.h>

possession of this data allows impersonation

◆ LLLF_SECRECY_PII

#define LLLF_SECRECY_PII   (1 << 16)

#include <include/libwebsockets/lws-logs.h>

contains Personally Identifiable Information

◆ lwsl_client

#define lwsl_client ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx

#define lwsl_cx ( _c,
_fil,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log_cx(lwsl_context_get_cx(_c), lws_log_prepend_context, \
_c, _fil, __func__, __VA_ARGS__)
175#define lwsl_cx(_c, _fil, ...) \
176 _lws_log_cx(lwsl_context_get_cx(_c), lws_log_prepend_context, \
177 _c, _fil, __func__, __VA_ARGS__)

◆ lwsl_cx_client

#define lwsl_cx_client ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_debug

#define lwsl_cx_debug ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_err

#define lwsl_cx_err ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_cx(_c, LLL_ERR, __VA_ARGS__)

◆ lwsl_cx_ext

#define lwsl_cx_ext ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_header

#define lwsl_cx_header ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_info

#define lwsl_cx_info ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_latency

#define lwsl_cx_latency ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_notice

#define lwsl_cx_notice ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_cx(_c, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_cx_parser

#define lwsl_cx_parser ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_thread

#define lwsl_cx_thread ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_cx_user

#define lwsl_cx_user ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_cx(_c, LLL_USER, __VA_ARGS__)

◆ lwsl_cx_warn

#define lwsl_cx_warn ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_cx(_c, LLL_WARN, __VA_ARGS__)

◆ lwsl_debug

#define lwsl_debug ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_err

#define lwsl_err ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log(LLL_ERR, __VA_ARGS__)

◆ lwsl_ext

#define lwsl_ext ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_header

#define lwsl_header ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_hexdump_context

#define lwsl_hexdump_context ( _c,
_fil,
_buf,
_len )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level_cx(lwsl_context_get_cx(_c), \
lws_log_prepend_context, \
_c, _fil, _buf, _len)
188#define lwsl_hexdump_context(_c, _fil, _buf, _len) \
189 lwsl_hexdump_level_cx(lwsl_context_get_cx(_c), \
190 lws_log_prepend_context, \
191 _c, _fil, _buf, _len)

◆ lwsl_hexdump_cx_debug

#define lwsl_hexdump_cx_debug ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_context(_c, LLL_DEBUG, __VA_ARGS__)

◆ lwsl_hexdump_cx_err

#define lwsl_hexdump_cx_err ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_context(_c, LLL_ERR, __VA_ARGS__)

◆ lwsl_hexdump_cx_info

#define lwsl_hexdump_cx_info ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_context(_c, LLL_INFO, __VA_ARGS__)

◆ lwsl_hexdump_cx_notice

#define lwsl_hexdump_cx_notice ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_context(_c, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_hexdump_cx_warn

#define lwsl_hexdump_cx_warn ( _c,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_context(_c, LLL_WARN, __VA_ARGS__)

◆ lwsl_hexdump_debug

#define lwsl_hexdump_debug ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level(LLL_DEBUG, __VA_ARGS__)
lwsl_hexdump_level
LWS_VISIBLE LWS_EXTERN void lwsl_hexdump_level(int level, const void *vbuf, size_t len)

◆ lwsl_hexdump_err

#define lwsl_hexdump_err ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level(LLL_ERR, __VA_ARGS__)

◆ lwsl_hexdump_info

#define lwsl_hexdump_info ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level(LLL_INFO, __VA_ARGS__)

◆ lwsl_hexdump_notice

#define lwsl_hexdump_notice ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level(LLL_NOTICE, __VA_ARGS__)

◆ lwsl_hexdump_ss

#define lwsl_hexdump_ss ( _h,
_fil,
_buf,
_len )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level_cx(lwsl_ss_get_cx(_h), \
lws_log_prepend_ss, \
_h, _fil, _buf, _len)
200#define lwsl_hexdump_ss(_h, _fil, _buf, _len) \
201 lwsl_hexdump_level_cx(lwsl_ss_get_cx(_h), \
202 lws_log_prepend_ss, \
203 _h, _fil, _buf, _len)

◆ lwsl_hexdump_ss_debug

#define lwsl_hexdump_ss_debug ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_ss(_v, LLL_DEBUG, __VA_ARGS__)

◆ lwsl_hexdump_ss_err

#define lwsl_hexdump_ss_err ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_ss(_v, LLL_ERR, __VA_ARGS__)

◆ lwsl_hexdump_ss_info

#define lwsl_hexdump_ss_info ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_ss(_v, LLL_INFO, __VA_ARGS__)

◆ lwsl_hexdump_ss_notice

#define lwsl_hexdump_ss_notice ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_ss(_v, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_hexdump_ss_warn

#define lwsl_hexdump_ss_warn ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_ss(_v, LLL_WARN, __VA_ARGS__)

◆ lwsl_hexdump_vhost

#define lwsl_hexdump_vhost ( _v,
_fil,
_buf,
_len )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level_cx(lwsl_vhost_get_cx(_v), \
lws_log_prepend_vhost, \
_v, _fil, _buf, _len)
192#define lwsl_hexdump_vhost(_v, _fil, _buf, _len) \
193 lwsl_hexdump_level_cx(lwsl_vhost_get_cx(_v), \
194 lws_log_prepend_vhost, \
195 _v, _fil, _buf, _len)

◆ lwsl_hexdump_vhost_debug

#define lwsl_hexdump_vhost_debug ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_vhost(_v, LLL_DEBUG, __VA_ARGS__)

◆ lwsl_hexdump_vhost_err

#define lwsl_hexdump_vhost_err ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_vhost(_v, LLL_ERR, __VA_ARGS__)

◆ lwsl_hexdump_vhost_info

#define lwsl_hexdump_vhost_info ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_vhost(_v, LLL_INFO, __VA_ARGS__)

◆ lwsl_hexdump_vhost_notice

#define lwsl_hexdump_vhost_notice ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_vhost(_v, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_hexdump_vhost_warn

#define lwsl_hexdump_vhost_warn ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_vhost(_v, LLL_WARN, __VA_ARGS__)

◆ lwsl_hexdump_warn

#define lwsl_hexdump_warn ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level(LLL_WARN, __VA_ARGS__)

◆ lwsl_hexdump_wsi

#define lwsl_hexdump_wsi ( _w,
_fil,
_buf,
_len )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_level_cx(lwsl_wsi_get_cx(_w), \
lws_log_prepend_wsi, \
_w, _fil, _buf, _len)
196#define lwsl_hexdump_wsi(_w, _fil, _buf, _len) \
197 lwsl_hexdump_level_cx(lwsl_wsi_get_cx(_w), \
198 lws_log_prepend_wsi, \
199 _w, _fil, _buf, _len)

◆ lwsl_hexdump_wsi_debug

#define lwsl_hexdump_wsi_debug ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_wsi(_v, LLL_DEBUG, __VA_ARGS__)

◆ lwsl_hexdump_wsi_err

#define lwsl_hexdump_wsi_err ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_wsi(_v, LLL_ERR, __VA_ARGS__)

◆ lwsl_hexdump_wsi_info

#define lwsl_hexdump_wsi_info ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_wsi(_v, LLL_INFO, __VA_ARGS__)

◆ lwsl_hexdump_wsi_notice

#define lwsl_hexdump_wsi_notice ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_wsi(_v, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_hexdump_wsi_warn

#define lwsl_hexdump_wsi_warn ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_hexdump_wsi(_v, LLL_WARN, __VA_ARGS__)

◆ lwsl_info

#define lwsl_info ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_latency

#define lwsl_latency ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_notice

#define lwsl_notice ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log(LLL_NOTICE, __VA_ARGS__)

◆ lwsl_parser

#define lwsl_parser ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss

#define lwsl_ss ( _h,
_fil,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log_cx(lwsl_ss_get_cx(_h), lws_log_prepend_ss, _h, \
_fil, __func__, __VA_ARGS__)
184#define lwsl_ss(_h, _fil, ...) \
185 _lws_log_cx(lwsl_ss_get_cx(_h), lws_log_prepend_ss, _h, \
186 _fil, __func__, __VA_ARGS__)

◆ lwsl_ss_client

#define lwsl_ss_client ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_debug

#define lwsl_ss_debug ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_err

#define lwsl_ss_err ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_ss(_w, LLL_ERR, __VA_ARGS__)

◆ lwsl_ss_ext

#define lwsl_ss_ext ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_header

#define lwsl_ss_header ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_info

#define lwsl_ss_info ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_latency

#define lwsl_ss_latency ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_notice

#define lwsl_ss_notice ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_ss(_w, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_ss_parser

#define lwsl_ss_parser ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_thread

#define lwsl_ss_thread ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_ss_user

#define lwsl_ss_user ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_ss(_w, LLL_USER, __VA_ARGS__)

◆ lwsl_ss_warn

#define lwsl_ss_warn ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_ss(_w, LLL_WARN, __VA_ARGS__)

◆ lwsl_thread

#define lwsl_thread ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_user

#define lwsl_user ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log(LLL_USER, __VA_ARGS__)

◆ lwsl_vhost

#define lwsl_vhost ( _v,
_fil,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log_cx(lwsl_vhost_get_cx(_v), lws_log_prepend_vhost, _v, \
_fil, __func__, __VA_ARGS__)
178#define lwsl_vhost(_v, _fil, ...) \
179 _lws_log_cx(lwsl_vhost_get_cx(_v), lws_log_prepend_vhost, _v, \
180 _fil, __func__, __VA_ARGS__)

◆ lwsl_vhost_client

#define lwsl_vhost_client ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_debug

#define lwsl_vhost_debug ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_err

#define lwsl_vhost_err ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_vhost(_v, LLL_ERR, __VA_ARGS__)

◆ lwsl_vhost_ext

#define lwsl_vhost_ext ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_header

#define lwsl_vhost_header ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_info

#define lwsl_vhost_info ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_latency

#define lwsl_vhost_latency ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_notice

#define lwsl_vhost_notice ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_vhost(_v, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_vhost_parser

#define lwsl_vhost_parser ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_thread

#define lwsl_vhost_thread ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_vhost_user

#define lwsl_vhost_user ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_vhost(_v, LLL_USER, __VA_ARGS__)

◆ lwsl_vhost_warn

#define lwsl_vhost_warn ( _v,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_vhost(_v, LLL_WARN, __VA_ARGS__)

◆ lwsl_warn

#define lwsl_warn ( ...)

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log(LLL_WARN, __VA_ARGS__)

◆ lwsl_wsi

#define lwsl_wsi ( _w,
_fil,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
_lws_log_cx(lwsl_wsi_get_cx(_w), lws_log_prepend_wsi, _w, \
_fil, __func__, __VA_ARGS__)
181#define lwsl_wsi(_w, _fil, ...) \
182 _lws_log_cx(lwsl_wsi_get_cx(_w), lws_log_prepend_wsi, _w, \
183 _fil, __func__, __VA_ARGS__)

◆ lwsl_wsi_client

#define lwsl_wsi_client ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_debug

#define lwsl_wsi_debug ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_err

#define lwsl_wsi_err ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_wsi(_w, LLL_ERR, __VA_ARGS__)

◆ lwsl_wsi_ext

#define lwsl_wsi_ext ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_header

#define lwsl_wsi_header ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_info

#define lwsl_wsi_info ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_latency

#define lwsl_wsi_latency ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_notice

#define lwsl_wsi_notice ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_wsi(_w, LLL_NOTICE, __VA_ARGS__)

◆ lwsl_wsi_parser

#define lwsl_wsi_parser ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_thread

#define lwsl_wsi_thread ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
do {} while(0)

◆ lwsl_wsi_user

#define lwsl_wsi_user ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_wsi(_w, LLL_USER, __VA_ARGS__)

◆ lwsl_wsi_warn

#define lwsl_wsi_warn ( _w,
... )

#include <include/libwebsockets/lws-logs.h>

Value:
lwsl_wsi(_w, LLL_WARN, __VA_ARGS__)

Function Documentation

◆ lws_set_log_level()

LWS_VISIBLE LWS_EXTERN void lws_set_log_level ( int level,
lws_log_emit_t log_emit_function )

#include <include/libwebsockets/lws-logs.h>

lws_set_log_level() - Set the logging bitfield

Parameters
levelOR together the LLL_ debug contexts you want output from
log_emit_functionNULL to leave it as it is, or a user-supplied function to perform log string emission instead of the default stderr one.

log level defaults to "err", "warn" and "notice" contexts enabled and emission on stderr. If stderr is a tty (according to isatty()) then the output is coloured according to the log level using ANSI escapes.

You can set the default security level for logging using the secrecy_and_log_level() macro to set the level parameter, eg

lws_set_log_level(secrecy_and_log_level(LWS_SECRECY_PII, LLL_ERR | LLL_WARN), my_emit_function);

Normally you can just leave it at the default.

◆ lwsl_emit_stderr()

LWS_VISIBLE LWS_EXTERN void lwsl_emit_stderr ( int level,
const char * line )

#include <include/libwebsockets/lws-logs.h>

lwsl_emit_stderr() - helper log emit function writes to stderr

Parameters
levelone of LLL_ log level indexes
linelog string

You use this by passing the function pointer to lws_set_log_level(), to set it as the log emit function, it is not called directly.

It prepends a system timestamp like [2018/11/13 07:41:57:3989]

If stderr is a tty, then ansi colour codes are added.

◆ lwsl_emit_stderr_notimestamp()

LWS_VISIBLE LWS_EXTERN void lwsl_emit_stderr_notimestamp ( int level,
const char * line )

#include <include/libwebsockets/lws-logs.h>

lwsl_emit_stderr_notimestamp() - helper log emit function writes to stderr

Parameters
levelone of LLL_ log level indexes
linelog string

You use this by passing the function pointer to lws_set_log_level(), to set it as the log emit function, it is not called directly.

If stderr is a tty, then ansi colour codes are added.

◆ lwsl_emit_syslog()

LWS_VISIBLE LWS_EXTERN void lwsl_emit_syslog ( int level,
const char * line )

#include <include/libwebsockets/lws-logs.h>

lwsl_emit_syslog() - helper log emit function writes to system log

Parameters
levelone of LLL_ log level indexes
linelog string

You use this by passing the function pointer to lws_set_log_level(), to set it as the log emit function, it is not called directly.

◆ lwsl_hexdump()

LWS_VISIBLE LWS_EXTERN void lwsl_hexdump ( const void * buf,
size_t len )

#include <include/libwebsockets/lws-logs.h>

lwsl_hexdump() - helper to hexdump a buffer (DEBUG builds only)

Parameters
bufbuffer start to dump
lenlength of buffer to dump

Calls through to lwsl_hexdump_level(LLL_DEBUG, ... for compatability. It's better to use lwsl_hexdump_level(level, ... directly so you can control the visibility.

◆ lwsl_hexdump_level()

LWS_VISIBLE LWS_EXTERN void lwsl_hexdump_level ( int level,
const void * vbuf,
size_t len )

#include <include/libwebsockets/lws-logs.h>

lwsl_hexdump_level() - helper to hexdump a buffer at a selected debug level

Parameters
levelone of LLL_ constants
vbufbuffer start to dump
lenlength of buffer to dump

If level is visible, does a nice hexdump -C style dump of vbuf for len bytes. This can be extremely convenient while debugging.

◆ lwsl_timestamp()

LWS_VISIBLE LWS_EXTERN int lwsl_timestamp ( int level,
char * p,
size_t len )

#include <include/libwebsockets/lws-logs.h>

lwsl_timestamp: generate logging timestamp string

Parameters
levellogging level
pchar * buffer to take timestamp
lenlength of p

returns length written in p

◆ lwsl_visible()

LWS_VISIBLE LWS_EXTERN int lwsl_visible ( int level)

#include <include/libwebsockets/lws-logs.h>

lwsl_visible() - returns true if the log level should be printed

Parameters
levelone of LLL_ log level indexes

This is useful if you have to do work to generate the log content, you can skip the work if the log level used to print it is not actually enabled at runtime.