dlog.h

NAME

dlog.h - Contains a robust API for logging messages.

SYNOPSIS


#include <syslog.h>
#include <stdarg.h>

Defines

#define DAEMON_GCC_PRINTF_ATTR(a, b)
#define DAEMON_LOGV_AVAILABLE 1
This variable is defined to 1 iff daemon_logv() is supported.

Enumerations

enum daemon_log_flags { DAEMON_LOG_SYSLOG = 1, DAEMON_LOG_STDERR = 2, DAEMON_LOG_STDOUT = 4, DAEMON_LOG_AUTO = 8 }
Specifies where to send the log messages to.

Functions

void daemon_log (int prio, const char *t,...) DAEMON_GCC_PRINTF_ATTR(2
Log a message using printf format strings using the specified syslog priority. void daemon_logv (int prio, const char *t, va_list ap)
Same as daemon_logv, but without variadic arguments. char * daemon_ident_from_argv0 (char *argv0)
Return a sensible syslog identification for daemon_log_ident generated from argv[0].

Variables

enum daemon_log_flags daemon_log_use
This variable is used to specify the log target(s) to use. const char * daemon_log_ident
Specifies the syslog identification, use daemon_ident_from_argv0() to set this to a sensible value or generate your own.

Detailed Description

Contains a robust API for logging messages.
Definition in file dlog.h.

Define Documentation

#define DAEMON_GCC_PRINTF_ATTR(a, b)

Definition at line 59 of file dlog.h.

#define DAEMON_LOGV_AVAILABLE 1

This variable is defined to 1 iff daemon_logv() is supported.
Definition at line 69 of file dlog.h.

Enumeration Type Documentation

enum daemon_log_flags

Specifies where to send the log messages to.
The global variable daemon_log_use takes values of this type.
Enumerator:
DAEMON_LOG_SYSLOG
Log messages are written to syslog.
DAEMON_LOG_STDERR
Log messages are written to STDERR.
DAEMON_LOG_STDOUT
Log messages are written to STDOUT.
DAEMON_LOG_AUTO
If this is set a daemon_fork() will change this to DAEMON_LOG_SYSLOG in the daemon process.
Definition at line 39 of file dlog.h.

Function Documentation

char* daemon_ident_from_argv0 (char * argv0)

Return a sensible syslog identification for daemon_log_ident generated from argv[0].
This will return a pointer to the file name of argv[0], i.e. strrchr(argv[0], '\')+1
Parameters:
argv0 argv[0] as passed to main()
Returns:
The identification string
Examples: testd.c.

void daemon_log (int prio, const char * t, ...)

Log a message using printf format strings using the specified syslog priority.
Parameters:
prio The syslog priority (PRIO_xxx constants)
t,... The text message to log
Examples: testd.c.

void daemon_logv (int prio, const char * t, va_list ap)

Same as daemon_logv, but without variadic arguments.

Variable Documentation

const char* daemon_log_ident

Specifies the syslog identification, use daemon_ident_from_argv0() to set this to a sensible value or generate your own.
Examples: testd.c.

enum daemon_log_flags daemon_log_use

This variable is used to specify the log target(s) to use.
Defaults to DAEMON_LOG_STDERR|DAEMON_LOG_AUTO

Author

Generated automatically by Doxygen for libdaemon from the source code.