upipe/uprobe_output.h header reference

probe dealing with events having consequences on the output pipe More

Header inclusion  

Members  

Type  

Functions  

Description  

In particular, it catches the new_flow_def event, and calls upipe_set_flow_def on the output. If it returns an error, the output is cleared and the event is forwarded to higher-level probes.

It also catches the new_flow_format event, and calls upipe_amend_flow_format on the output, so that it can tune the parameters of the new ubuf manager (alignment, prepending and appending). The event is then always forwarded to higher-level probes.

Members detail  

#define _UPIPE_UPROBE_OUTPUT_H_  

This macro is declared in upipe/uprobe_output.h source file, line 40.

struct uprobe_output  

This struct is declared in upipe/uprobe_output.h source file, line 53.

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

FieldDescription
struct uprobe uprobe;structure exported to modules

struct uprobe * uprobe_output_alloc(struct uprobe *next)  

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

This function allocates a new uprobe output structure.

Parameters list:

  • next: next probe to test if this one doesn't catch the event

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

void uprobe_output_clean(struct uprobe_output *uprobe_output)  

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

This function cleans a uprobe output structure.

Parameters list:

  • uprobe_output: structure to clean

struct uprobe * uprobe_output_init(struct uprobe_output *uprobe_output, struct uprobe *next)  

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

This function initializes an already allocated uprobe output structure.

Parameters list:

  • uprobe_output: pointer to the already allocated structure
  • next: next probe to test if this one doesn't catch the event

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

struct uprobe_output * uprobe_output_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 18 in upipe/uprobe_output.h source file, line 58.

This function returns the private uprobe_output structure.

Parameters list:

  • uprobe: public description structure of the probe

The return value is pointer to the private uprobe_output structure

struct uprobe * uprobe_output_to_uprobe(struct uprobe_output *s)  

This function is for internal use only.

This function is declared in UPROBE_HELPER_UPROBE function like macro expansion, line 8 in upipe/uprobe_output.h source file, line 58.

This function returns the public uprobe structure.

Parameters list:

  • uprobe_output: pointer to the private uprobe_output structure

The return value is pointer to the public uprobe structure

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:39 2014 using MkDoc