upipe/upipe_helper_uprobe.h header reference

Upipe helper functions for inner pipe probes More

• upipe/ubase.h
• upipe/uprobe.h

• UPIPE_HELPER_UPROBE

Upipe helper functions for inner pipe probes

This macro is declared in upipe/upipe_helper_uprobe.h source file, line 86.

This macro declares functions dealing with inner pipe probes, which internally catch and forward inner pipeline events.

You must add four members 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 and the name of your member is inner_probe, it declares:

• struct uprobe *upipe_foo_to_inner_probe(struct upipe_foo *upipe_foo)

  Returns a pointer to the public uprobe structure.

• struct upipe_foo *upipe_foo_from_inner_probe(struct uprobe *uprobe)

  Returns a pointer to the private upipe_foo structure.

• int upipe_foo_throw_proxy_inner_probe(struct uprobe *uprobe,
struct upipe *inner,
int event, va_list args)

  Used by the helper to attach the event from the inner pipe to the super pipe.

• void upipe_foo_init_inner_probe(struct upipe *upipe)

  Typically called in your upipe_foo_alloc() function.

• void upipe_foo_clean_inner_probe(struct upipe *upipe)

  Typically called from your upipe_foo_free() function.

Parameter list:

• STRUCTURE: name of your private upipe structure
• UREFCOUNT: the struct urefcount field of your private upipe structure.
• UPROBE: name of the struct uprobe field of your private upipe structure
• THROW: the name of the uprobe_throw_func function catching the events.

This macro is declared in upipe/upipe_helper_uprobe.h source file, line 28.