upipe/uprobe_stdio.h header reference

probe outputting all log events to stdio More

Header inclusion  

Members  

Type  

Functions  

Description  

probe outputting all log events to stdio

Members detail  

#define _UPIPE_UPROBE_STDIO_H_  

This macro is declared in upipe/uprobe_stdio.h source file, line 32.

struct uprobe_stdio  

This struct is declared in upipe/uprobe_stdio.h source file, line 43.

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

FieldDescription
FILE * stream;file stream to write to
enum uprobe_log_level min_level;minimum level of printed messages
bool colored;colored output enabled?
struct uprobe uprobe;structure exported to modules

struct uprobe * uprobe_stdio_alloc(struct uprobe *next, FILE *stream, enum uprobe_log_level min_level)  

This function is declared in upipe/uprobe_stdio.h source file, line 83.

This function allocates a new uprobe stdio structure.

Parameter list:

  • next: next probe to test if this one doesn't catch the event
  • stream: stdio stream to which to log the messages
  • level: level at which to log the messages

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

void uprobe_stdio_clean(struct uprobe_stdio *uprobe_stdio)  

This function is declared in upipe/uprobe_stdio.h source file, line 73.

This function cleans a uprobe_stdio structure.

Parameter list:

  • uprobe_stdio: structure to clean

struct uprobe * uprobe_stdio_init(struct uprobe_stdio *uprobe_stdio, struct uprobe *next, FILE *stream, enum uprobe_log_level min_level)  

This function is declared in upipe/uprobe_stdio.h source file, line 67.

This function initializes an already allocated uprobe_stdio structure.

Parameter list:

  • uprobe_stdio: pointer to the already allocated structure
  • next: next probe to test if this one doesn't catch the event
  • stream: stdio stream to which to log the messages
  • level: level at which to log the messages

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

void uprobe_stdio_set_color(struct uprobe *uprobe, bool enabled)  

This function is declared in upipe/uprobe_stdio.h source file, line 90.

This function enables or disables colored output.

Parameter list:

  • uprobe: pointer to probe
  • enabled: enable (or disable) colored output

struct uprobe_stdio * uprobe_stdio_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_stdio.h source file, line 55.

This function returns the private uprobe_stdio structure.

Parameter list:

  • uprobe: public description structure of the probe

The return value is pointer to the private uprobe_stdio structure

struct uprobe * uprobe_stdio_to_uprobe(struct uprobe_stdio *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_stdio.h source file, line 55.

This function returns the public uprobe structure.

Parameter list:

  • uprobe_stdio: pointer to the private uprobe_stdio 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