upipe/uprobe_syslog.h header reference

probe outputting all log events to syslog More

Header inclusion  

Members  

Type  

Functions  

  • struct uprobe * uprobe_syslog_alloc(struct uprobe *next, const char *ident, int option, int facility, enum uprobe_log_level min_level)
  • void uprobe_syslog_clean(struct uprobe_syslog *uprobe_syslog)
  • struct uprobe * uprobe_syslog_init(struct uprobe_syslog *uprobe_syslog, struct uprobe *next, const char *ident, int option, int facility, enum uprobe_log_level min_level)

Description  

probe outputting all log events to syslog

Members detail  

#define _UPIPE_UPROBE_SYSLOG_H_  

This macro is declared in upipe/uprobe_syslog.h source file, line 33.

struct uprobe_syslog  

This struct is declared in upipe/uprobe_syslog.h source file, line 44.

This struct is a super-set of the uprobe structure with additional local members.

FieldDescription
char * ident;syslog ident
int facility;syslog facility
bool inited;true if openlog was called
enum uprobe_log_level min_level;minimum level of printed messages
struct uprobe uprobe;structure exported to modules

struct uprobe * uprobe_syslog_alloc(struct uprobe *next, const char *ident, int option, int facility, enum uprobe_log_level min_level)  

This function is declared in upipe/uprobe_syslog.h source file, line 94.

This function allocates a new uprobe syslog structure.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • ident: syslog ident string (may be NULL)
  • option: syslog option (see syslog(3)), or -1 to not call openlog
  • facility: syslog facility (see syslog(3))
  • init: true if openlog(3) must be called
  • level: level at which to log the messages

The return value is pointer to uprobe, or NULL in case of error

void uprobe_syslog_clean(struct uprobe_syslog *uprobe_syslog)  

This function is declared in upipe/uprobe_syslog.h source file, line 80.

This function cleans a uprobe_syslog structure.

Parameter list:

  • uprobe_syslog: structure to clean

struct uprobe * uprobe_syslog_init(struct uprobe_syslog *uprobe_syslog, struct uprobe *next, const char *ident, int option, int facility, enum uprobe_log_level min_level)  

This function is declared in upipe/uprobe_syslog.h source file, line 74.

This function initializes an already allocated uprobe_syslog structure.

Parameter list:

  • uprobe_syslog: pointer to the already allocated structure
  • next: next probe to test if this one doesn't catch the event
  • ident: syslog ident string (may be NULL)
  • option: syslog option (see syslog(3)), or -1 to not call openlog
  • facility: syslog facility (see syslog(3))
  • level: level at which to log the messages

The return value is pointer to uprobe, or NULL in case of error

struct uprobe_syslog * uprobe_syslog_from_uprobe(struct uprobe *uprobe)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 19 in upipe/uprobe_syslog.h source file, line 59.

This function returns the private uprobe_syslog structure.

Parameter list:

  • uprobe: public description structure of the probe

The return value is pointer to the private uprobe_syslog structure

struct uprobe * uprobe_syslog_to_uprobe(struct uprobe_syslog *s)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 9 in upipe/uprobe_syslog.h source file, line 59.

This function returns the public uprobe structure.

Parameter list:

  • uprobe_syslog: pointer to the private uprobe_syslog structure

The return value is pointer to the public uprobe structure

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:19 2018 using MkDoc