upipe/uprobe_stdio.h header reference
probe outputting all log events to stdio More
Header inclusion [link]
Members [link]
Type [link]
- struct uprobe_stdio
Functions [link]
- struct uprobe * uprobe_stdio_alloc(struct uprobe *next, FILE *stream, enum uprobe_log_level min_level)
- void uprobe_stdio_clean(struct uprobe_stdio *uprobe_stdio)
- struct uprobe * uprobe_stdio_init(struct uprobe_stdio *uprobe_stdio, struct uprobe *next, FILE *stream, enum uprobe_log_level min_level)
- void uprobe_stdio_set_color(struct uprobe *uprobe, bool enabled)
- int uprobe_stdio_set_time_format(struct uprobe *uprobe, const char *format)
Description [link]
probe outputting all log events to stdio
Members detail [link]
#define _UPIPE_UPROBE_STDIO_H_ [link]
This macro is declared in upipe/uprobe_stdio.h source file, line 33.
struct uprobe_stdio [link]
This struct is declared in upipe/uprobe_stdio.h source file, line 44.
This struct is a super-set of the uprobe structure with additional local members.
| Field | Description |
|---|---|
| FILE * stream; | file stream to write to |
| enum uprobe_log_level min_level; | minimum level of printed messages |
| bool colored; | colored output enabled? |
| char * time_format; | timing output format or NULL |
| struct uprobe uprobe; | structure exported to modules |
struct uprobe * uprobe_stdio_alloc(struct uprobe *next, FILE *stream, enum uprobe_log_level min_level) [link]
This function is declared in upipe/uprobe_stdio.h source file, line 86.
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) [link]
This function is declared in upipe/uprobe_stdio.h source file, line 76.
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) [link]
This function is declared in upipe/uprobe_stdio.h source file, line 70.
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
This function is declared in upipe/uprobe_stdio.h source file, line 93.
This function enables or disables colored output.
Parameter list:
- uprobe: pointer to probe
- enabled: enable (or disable) colored output
This function is declared in upipe/uprobe_stdio.h source file, line 101.
This function sets the output time format or disables it.
Parameter list:
- uprobe: pointer to probe
- format: strftime format or NULL to disable
The return value is an error code
struct uprobe_stdio * uprobe_stdio_from_uprobe(struct uprobe *uprobe) [link]
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 58.
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) [link]
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 58.
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