rpm 4.18.2
Macros | Typedefs | Enumerations | Functions
Logging API.

RPM Logging facilities. More...

Macros

#define RPMLOG_DEFAULT   0x01
 Option flags for callback return value.
 

Typedefs

typedef enum rpmlogLvl_e rpmlogLvl
 RPM Log levels.
 
typedef enum rpmlogFac_e rpmlogFac
 facility codes
 
typedef struct rpmlogRec_s * rpmlogRec
 
typedef int(* rpmlogCallback) (rpmlogRec rec, rpmlogCallbackData data)
 

Enumerations

enum  rpmlogLvl_e {
  RPMLOG_EMERG = 0 , RPMLOG_ALERT = 1 , RPMLOG_CRIT = 2 , RPMLOG_ERR = 3 ,
  RPMLOG_WARNING = 4 , RPMLOG_NOTICE = 5 , RPMLOG_INFO = 6 , RPMLOG_DEBUG = 7
}
 RPM Log levels. More...
 
enum  rpmlogFac_e {
  RPMLOG_KERN = (0<<3) , RPMLOG_USER = (1<<3) , RPMLOG_MAIL = (2<<3) , RPMLOG_DAEMON = (3<<3) ,
  RPMLOG_AUTH = (4<<3) , RPMLOG_SYSLOG = (5<<3) , RPMLOG_LPR = (6<<3) , RPMLOG_NEWS = (7<<3) ,
  RPMLOG_UUCP = (8<<3) , RPMLOG_CRON = (9<<3) , RPMLOG_AUTHPRIV = (10<<3) , RPMLOG_FTP = (11<<3) ,
  RPMLOG_LOCAL0 = (16<<3) , RPMLOG_LOCAL1 = (17<<3) , RPMLOG_LOCAL2 = (18<<3) , RPMLOG_LOCAL3 = (19<<3) ,
  RPMLOG_LOCAL4 = (20<<3) , RPMLOG_LOCAL5 = (21<<3) , RPMLOG_LOCAL6 = (22<<3) , RPMLOG_LOCAL7 = (23<<3) ,
  RPMLOG_ERRMSG = (((unsigned)( 24 +0))<<3)
}
 facility codes More...
 

Functions

const char * rpmlogRecMessage (rpmlogRec rec)
 Retrieve log message string from rpmlog record.
 
rpmlogLvl rpmlogRecPriority (rpmlogRec rec)
 Retrieve log priority from rpmlog record.
 
int rpmlogGetNrecsByMask (unsigned mask)
 Return number of rpmError() messages matching a log mask.
 
int rpmlogGetNrecs (void)
 Return number of rpmError() ressages.
 
void rpmlogPrintByMask (FILE *f, unsigned mask)
 Print all rpmError() messages matching a log mask.
 
void rpmlogPrint (FILE *f)
 Print all rpmError() messages.
 
void rpmlogClose (void)
 Close desriptor used to write to system logger.
 
void rpmlogOpen (const char *ident, int option, int facility)
 Open connection to system logger.
 
int rpmlogSetMask (int mask)
 Set the log mask level.
 
void rpmlog (int code, const char *fmt,...) RPM_GNUC_PRINTF(2
 Generate a log message using FMT string and option arguments.
 
void const char * rpmlogMessage (void)
 Return text of last rpmError() message.
 
int rpmlogCode (void)
 Return error code from last rpmError() message.
 
const char * rpmlogLevelPrefix (rpmlogLvl pri)
 Return translated prefix string (if any) given log level.
 
rpmlogCallback rpmlogSetCallback (rpmlogCallback cb, rpmlogCallbackData data)
 Set rpmlog callback function.
 
FILE * rpmlogSetFile (FILE *fp)
 Set rpmlog file handle.
 

Detailed Description

RPM Logging facilities.

Macro Definition Documentation

◆ RPMLOG_DEFAULT

#define RPMLOG_DEFAULT   0x01

Option flags for callback return value.

perform default logging

Definition at line 103 of file rpmlog.h.

Typedef Documentation

◆ rpmlogCallback

typedef int(* rpmlogCallback) (rpmlogRec rec, rpmlogCallbackData data)
Parameters
recrpmlog record
dataprivate callback data
Returns
flags to define further behavior: RPMLOG_DEFAULT to perform default logging, RPMLOG_EXIT to exit after processing, 0 to return after callback

Definition at line 134 of file rpmlog.h.

◆ rpmlogFac

typedef enum rpmlogFac_e rpmlogFac

facility codes

◆ rpmlogLvl

typedef enum rpmlogLvl_e rpmlogLvl

RPM Log levels.

priorities/facilities are encoded into a single 32-bit quantity, where the bottom 3 bits are the priority (0-7) and the top 28 bits are the facility (0-big number). Both the priorities and the facilities map roughly one-to-one to strings in the syslogd(8) source code. This mapping is included in this file.

priorities (these are ordered)

◆ rpmlogRec

typedef struct rpmlogRec_s* rpmlogRec

Definition at line 108 of file rpmlog.h.

Enumeration Type Documentation

◆ rpmlogFac_e

facility codes

Enumerator
RPMLOG_KERN 

kernel messages

RPMLOG_USER 

random user-level messages

RPMLOG_MAIL 

mail system

RPMLOG_DAEMON 

system daemons

RPMLOG_AUTH 

security/authorization messages

RPMLOG_SYSLOG 

messages generated internally by syslogd

RPMLOG_LPR 

line printer subsystem

RPMLOG_NEWS 

network news subsystem

RPMLOG_UUCP 

UUCP subsystem

RPMLOG_CRON 

clock daemon

RPMLOG_AUTHPRIV 

security/authorization messages (private)

RPMLOG_FTP 

ftp daemon

RPMLOG_LOCAL0 

reserved for local use

RPMLOG_LOCAL1 

reserved for local use

RPMLOG_LOCAL2 

reserved for local use

RPMLOG_LOCAL3 

reserved for local use

RPMLOG_LOCAL4 

reserved for local use

RPMLOG_LOCAL5 

reserved for local use

RPMLOG_LOCAL6 

reserved for local use

RPMLOG_LOCAL7 

reserved for local use

RPMLOG_ERRMSG 

Definition at line 49 of file rpmlog.h.

◆ rpmlogLvl_e

RPM Log levels.

priorities/facilities are encoded into a single 32-bit quantity, where the bottom 3 bits are the priority (0-7) and the top 28 bits are the facility (0-big number). Both the priorities and the facilities map roughly one-to-one to strings in the syslogd(8) source code. This mapping is included in this file.

priorities (these are ordered)

Enumerator
RPMLOG_EMERG 

system is unusable

RPMLOG_ALERT 

action must be taken immediately

RPMLOG_CRIT 

critical conditions

RPMLOG_ERR 

error conditions

RPMLOG_WARNING 

warning conditions

RPMLOG_NOTICE 

normal but significant condition

RPMLOG_INFO 

informational

RPMLOG_DEBUG 

debug-level messages

Definition at line 29 of file rpmlog.h.

Function Documentation

◆ rpmlog()

void rpmlog ( int  code,
const char *  fmt,
  ... 
)

Generate a log message using FMT string and option arguments.

◆ rpmlogClose()

void rpmlogClose ( void  )

Close desriptor used to write to system logger.

Todo:
Implement.

◆ rpmlogCode()

int rpmlogCode ( void  )

Return error code from last rpmError() message.

Deprecated:
Perl-RPM needs, what's really needed is predictable, non-i18n encumbered, error text that can be retrieved through rpmlogMessage() and parsed IMHO.
Returns
code from last message

◆ rpmlogGetNrecs()

int rpmlogGetNrecs ( void  )

Return number of rpmError() ressages.

Returns
number of messages

◆ rpmlogGetNrecsByMask()

int rpmlogGetNrecsByMask ( unsigned  mask)

Return number of rpmError() messages matching a log mask.

Parameters
masklog mask to filter by (0 is no filtering)
Returns
number of messages matching the mask

◆ rpmlogLevelPrefix()

const char * rpmlogLevelPrefix ( rpmlogLvl  pri)

Return translated prefix string (if any) given log level.

Parameters
prilog priority
Returns
message prefix (or "" for none)

◆ rpmlogMessage()

void const char * rpmlogMessage ( void  )

Return text of last rpmError() message.

Returns
text of last message

◆ rpmlogOpen()

void rpmlogOpen ( const char *  ident,
int  option,
int  facility 
)

Open connection to system logger.

Todo:
Implement.

◆ rpmlogPrint()

void rpmlogPrint ( FILE *  f)

Print all rpmError() messages.

Parameters
ffile handle (NULL uses stderr)

◆ rpmlogPrintByMask()

void rpmlogPrintByMask ( FILE *  f,
unsigned  mask 
)

Print all rpmError() messages matching a log mask.

Parameters
ffile handle (NULL uses stderr)
masklog mask to filter by (0 is no filtering)

◆ rpmlogRecMessage()

const char * rpmlogRecMessage ( rpmlogRec  rec)

Retrieve log message string from rpmlog record.

Parameters
recrpmlog record
Returns
log message

◆ rpmlogRecPriority()

rpmlogLvl rpmlogRecPriority ( rpmlogRec  rec)

Retrieve log priority from rpmlog record.

Parameters
recrpmlog record
Returns
log priority

◆ rpmlogSetCallback()

rpmlogCallback rpmlogSetCallback ( rpmlogCallback  cb,
rpmlogCallbackData  data 
)

Set rpmlog callback function.

Parameters
cbrpmlog callback function
datacallback private (user) data
Returns
previous rpmlog callback function

◆ rpmlogSetFile()

FILE * rpmlogSetFile ( FILE *  fp)

Set rpmlog file handle.

Parameters
fprpmlog file handle (NULL uses stdout/stderr)
Returns
previous rpmlog file handle

◆ rpmlogSetMask()

int rpmlogSetMask ( int  mask)

Set the log mask level.

Parameters
masklog mask (0 is no operation)
Returns
previous log mask