upipe/upipe_helper_upump.h header reference

Upipe helper functions for pumps More

• upipe/ubase.h
• upipe/upump.h
• upipe/upipe.h

• UPIPE_HELPER_UPUMP

Upipe helper functions for pumps

This macro is declared in upipe/upipe_helper_upump.h source file, line 84.

This macro declares three functions dealing with a pump which we suppose serves as a worker task for the pipe.

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

You must also declare UPIPE_HELPER_UPIPE prior to using this macro. Also we suppose that you have a upump manager available in your structure.

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

• void upipe_foo_init_upump(struct upipe *upipe)

  Typically called in your upipe_foo_alloc() function.

• void upipe_foo_set_upump(struct upipe *upipe, struct upump *upump)

  Called whenever you allocate or free the worker.

• void upipe_foo_wait_upump(struct upipe *upipe, uint64_t delay, upump_cb cb)

  Creates a time upump waiting for the given delay, and calling the callback cb.

• void upipe_foo_clean_upump(struct upipe *upipe)

  Typically called from your upipe_foo_free() function.

Parameter list:

• STRUCTURE: name of your private upipe structure
• UPUMP: name of the struct upump * field of your private upipe structure
• UPUMP_MGR: name of the struct upump_mgr * field of your private upipe structure

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