upipe/upipe_helper_flow.h header reference

Upipe helper functions for pipes taking an output flow in upipe_alloc More

• upipe/ubase.h
• upipe/uref.h
• upipe/uref_flow.h
• upipe/upipe.h

• UPIPE_HELPER_FLOW

Upipe helper functions for pipes taking an output flow in upipe_alloc

This macro is declared in upipe/upipe_helper_flow.h source file, line 66.

This macro declares two functions dealing with the allocation of a pipe requiring an output flow definition.

You must declare UPIPE_HELPER_UPIPE prior to using this macro.

Supposing the name of your structure is upipe_foo, it declares:

• struct upipe *upipe_foo_alloc_flow(struct upipe_mgr *mgr,
struct uprobe *uprobe,
uint32_t signature, va_list args,
struct uref **flow_def_p)

  Allocates and initializes the private structure upipe_foo, checks the flow definition, and duplicates it to flow_def_p if not NULL.

• void upipe_foo_free_flow(struct upipe *upipe)

  Frees the private structure upipe_foo.

Parameter list:

• STRUCTURE: name of your private upipe structure
• EXPECTED_FLOW_DEF: wanted prefix of the flow definition, or NULL

This macro is declared in upipe/upipe_helper_flow.h source file, line 31.