upipe/upipe_helper_flow.h header reference

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

Header inclusion  

Members  

Macro  

Description  

Upipe helper functions for pipes taking an output flow in upipe_alloc

Members detail  

#define UPIPE_HELPER_FLOW(STRUCTURE, EXPECTED_FLOW_DEF)  

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

#define _UPIPE_UPIPE_HELPER_FLOW_H_  

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

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:19 2018 using MkDoc