upipe/upipe_helper_urefcount.h header reference

Upipe helper functions for refcount structures More

• upipe/ubase.h
• upipe/urefcount.h
• upipe/upipe.h

• UPIPE_HELPER_UREFCOUNT

Upipe helper functions for refcount structures

This macro is declared in upipe/upipe_helper_urefcount.h source file, line 79.

This macro declares three functions dealing with public and private parts of the allocated pipe structure.

You must add the urefcount structure to your private pipe structure:

You must also declare UPIPE_HELPER_UPIPE prior to using this macro, and have a function to free the structure when the refcount goes down to 0:

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

• void upipe_foo_dead_urefcount(struct urefcount *urefcount)

  Internal wrapper for upipe_foo_free.

• void upipe_foo_init_urefcount(struct upipe *upipe)

  Typically called in your upipe_foo_alloc() function.

• void upipe_foo_clean_urefcount(struct upipe *upipe)

  Typically called from your upipe_foo_free() function.

Parameters list:

• STRUCTURE: name of your private upipe structure
• UREFCOUNT: name of the struct urefcount field of your private upipe structure
• DEAD: name of the function to free the structure

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