upipe/upipe_helper_flow_def_check.h header reference

Upipe helper functions to check input flow definition More

• upipe/ubase.h
• upipe/uref.h
• upipe/udict.h
• upipe/upipe.h

• UPIPE_HELPER_FLOW_DEF_CHECK

Upipe helper functions to check input flow definition

This macro is declared in upipe/upipe_helper_flow_def_check.h source file, line 87.

This macro declares five functions dealing with the checking of input flow definitions in pipes.

You must add one member to your private upipe structure, for instance:

You must also declare UPIPE_HELPER_UPIPE prior to using this macro.

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

• void upipe_foo_init_flow_def_check(struct upipe *upipe)

  Typically called in your upipe_foo_alloc() function.

• struct uref *upipe_foo_alloc_flow_def_check(struct upipe *upipe,
struct uref *flow_def_input)

  Called whenever you need to allocate a flow definition check packet.

• bool upipe_foo_check_flow_def_check(struct upipe *upipe,
struct uref *flow_def_check)

  Checks a flow definition check packet derived from a new input flow definition, against the stored flow def check uref.

• void upipe_foo_store_flow_def_check(struct upipe *upipe,
struct uref *flow_def_check)

  Stores a new flow def check uref.

• void upipe_foo_clean_flow_def_check(struct upipe *upipe)

  Typically called from your upipe_foo_free() function.

Parameters list:

• STRUCTURE: name of your private upipe structure
• FLOW_DEF_CHECK: name of the struct uref * field of your private upipe structure, pointing to the flow definition check

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