Ft typedef void
Fn *krb5_log_log_func_t const char *time const char *message void *data
Ft typedef void
Fn *krb5_log_close_func_t void *data
Fn krb5_addlog_dest krb5_context context krb5_log_facility *facility const char *destination
Fn krb5_addlog_func krb5_context context krb5_log_facility *facility int min int max krb5_log_log_func_t log krb5_log_close_func_t close void *data
Fn krb5_closelog krb5_context context krb5_log_facility *facility
Fn krb5_initlog krb5_context context const char *program krb5_log_facility **facility
Fn krb5_log krb5_context context krb5_log_facility *facility int level const char *format ...
Fn krb5_log_msg krb5_context context krb5_log_facility *facility char **reply int level const char *format ...
Fn krb5_openlog krb5_context context const char *program krb5_log_facility **facility
Fn krb5_vlog krb5_context context krb5_log_facility *facility int level const char *format va_list arglist
Fn krb5_vlog_msg krb5_context context krb5_log_facility *facility char **reply int level const char *format va_list arglist
These functions logs messages to one or more destinations.
function creates a logging
Fa facility ,
that is used to log messages. A facility consists of one or more
destinations (which can be files or syslog or some other device). The
parameter should be the generic name of the program that is doing the
logging. This name is used to lookup which destinations to use. This
information is contained in the
section of the
configuration file. If no entry is found for
Fa program ,
the entry for
is used, or if that is missing too,
will be used as destination.
To close a logging facility, use the
To log a message to a facility use one of the functions
Fn krb5_log ,
Fn krb5_log_msg ,
Fn krb5_vlog ,
Fn krb5_vlog_msg .
The functions ending in
a pointer to the message that just got logged. This string is allocated,
and should be freed with
Fn free .
is a standard
style format string (but see the BUGS section).
If you want better control of where things gets logged, you can instead of using
Fn krb5_initlog ,
which just initializes a facility, but doesn't define any actual logging
destinations. You can then add destinations with the
functions. The first of these takes a string specifying a logging
destination, and adds this to the facility. If you want to do some
non-standard logging you can use the
function, which takes a function to use when logging.
function is called for each message with
being a string specifying the current time, and
the message to log.
is called when the facility is closed. You can pass application specific data in the
parameter are the same as in a destination (defined below). To specify a
max of infinity, pass -1.
and then calls
for each destination found.
The defined destinations (as specified in
This logs to the program's stderr.
Log to the specified file. The form using a colon appends to the file, the
form with an equal truncates the file. The truncating form keeps the file
open, while the appending form closes it after each log message (which
makes it possible to rotate logs). The truncating form is mainly for
compatibility with the MIT libkrb5.
This logs to the specified device, at present this is the same as
Log to the console, this is the same as
SYSLOG [:priority [:facility]
Send messages to the syslog system, using priority, and facility. To
get the name for one of these, you take the name of the macro passed
and remove the leading
The default values (as well as the values used for unrecognised
for a list of priorities and facilities.
Each destination may optionally be prepended with a range of logging
levels, specified as
is within this range (inclusive) the message gets logged to this
destination, otherwise not. Either of the min and max valued may be
omitted, in this case min is assumed to be zero, and max is assumed to be
infinity. If you don't include a dash, both min and max gets set to the
specified value. If no range is specified, all messages gets logged.
This will log all messages from the
program with level 0 to
other messages will be logged to syslog with priority
All other programs will log all messages to their stderr.
These functions use
to format the message. If your operating system does not have a working
Fn asprintf ,
a replacement will be used. At present this replacement does not handle
some correct conversion specifications (like floating point numbers). Until
this is fixed, the use of these conversions should be avoided.
If logging is done to the syslog facility, these functions might not be
thread-safe, depending on the implementation of
Fn openlog ,
Fn syslog .