view src/lib/log-throttle.h @ 23007:36e01285b5b8

lib: buffer - Improve header comment for buffer_insert() and buffer_delete().
author Stephan Bosch <stephan.bosch@dovecot.fi>
date Mon, 18 Mar 2019 00:52:37 +0100
parents 3e02c55136a6
children
line wrap: on
line source

#ifndef LOG_THROTTLE_H
#define LOG_THROTTLE_H

struct log_throttle_settings {
	/* Start throttling after we reach this many log events/interval. */
	unsigned int throttle_at_max_per_interval;
	/* Throttling continues until there's only this many or below
	   log events/interval. */
	unsigned int unthrottle_at_max_per_interval;
	/* Interval unit in milliseconds. The throttled-callback is also called
	   at this interval. Default (0) is 1000 milliseconds. */
	unsigned int interval_msecs;
};

typedef void
log_throttle_callback_t(unsigned int new_events_count, void *context);

struct log_throttle *
log_throttle_init(const struct log_throttle_settings *set,
		  log_throttle_callback_t *callback, void *context);
#define log_throttle_init(set, callback, context) \
	log_throttle_init(set + \
		CALLBACK_TYPECHECK(callback, void (*)(unsigned int, typeof(context))), \
		(log_throttle_callback_t *)callback, context)
void log_throttle_deinit(struct log_throttle **throttle);

/* Increase event count. Returns TRUE if the event should be logged,
   FALSE if it's throttled. ioloop_timeval is used to determine the current
   time. */
bool log_throttle_accept(struct log_throttle *throttle);

#endif