src/lib/event-log.h

	event-log.h revision c6ab22366939966e59492b29fd42a350d54331f0
#ifndef EVENT_LOG_H
#define EVENT_LOG_H

struct event_filter;

#include "lib-event.h"

struct event_log_params {
    enum log_type log_type;
    const char *source_filename;
    unsigned int source_linenum;
};

void e_error(struct event *event,
         const char *source_filename, unsigned int source_linenum,
         const char *fmt, ...) ATTR_FORMAT(4, 5);
#define e_error(event, ...) \
    e_error(event, __FILE__, __LINE__, __VA_ARGS__)
void e_warning(struct event *event,
           const char *source_filename, unsigned int source_linenum,
           const char *fmt, ...) ATTR_FORMAT(4, 5);
#define e_warning(event, ...) \
    e_warning(event, __FILE__, __LINE__, __VA_ARGS__)
void e_info(struct event *event,
        const char *source_filename, unsigned int source_linenum,
        const char *fmt, ...) ATTR_FORMAT(4, 5);
#define e_info(event, ...) \
    e_info(event, __FILE__, __LINE__, __VA_ARGS__)
void e_debug(struct event *event,
         const char *source_filename, unsigned int source_linenum,
         const char *fmt, ...) ATTR_FORMAT(4, 5);
#define e_debug(_event, ...) STMT_START { \
    struct event *_tmp_event = (_event); \
    if (event_want_debug(_tmp_event, __FILE__, __LINE__)) \
        e_debug(_tmp_event, __FILE__, __LINE__, __VA_ARGS__); \
    else \
        event_send_abort(_tmp_event); \
    } STMT_END
/* Returns TRUE if debug event should be sent (either logged or sent to
   stats). */
bool event_want_debug(struct event *event, const char *source_filename,
              unsigned int source_linenum);

void event_log(struct event *event, const struct event_log_params *params,
           const char *fmt, ...)
    ATTR_FORMAT(3, 4);
void event_logv(struct event *event, const struct event_log_params *params,
        const char *fmt, va_list args)
    ATTR_FORMAT(3, 0);

/* If debugging is forced, the global debug log filter is ignored. Changing
   this applies only to this event and any child event that is created
   afterwards. It doesn't apply to existing child events (mainly for
   performance reasons).

   Note that it's always recommended to use e.g.:
     if (set->debug) event_set_forced_debug(event, TRUE); // good
   instead of
     event_set_forced_debug(event, set->debug); // bad
   This is because the event may already have had debugging enabled via the
   parent event. Forcing it to FALSE is most likely not wanted. */
struct event *event_set_forced_debug(struct event *event, bool force);
/* Set the global filter to logging debug events. */
void event_set_global_debug_log_filter(struct event_filter *filter);
/* Return the current global debug log event filter. */
struct event_filter *event_get_global_debug_log_filter(void);
/* Unset global debug log filter, if one exists. */
void event_unset_global_debug_log_filter(void);

/* Set the global filter to sending debug events. The debug events are also
   sent if they match the global debug log filter. */
void event_set_global_debug_send_filter(struct event_filter *filter);
/* Return the current global debug send event filter. */
struct event_filter *event_get_global_debug_send_filter(void);
/* Unset global debug send filter, if one exists. */
void event_unset_global_debug_send_filter(void);

#endif