upipe/upump_blocker.h header reference

common declarations for event loop handlers More

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

• struct upump_blocker
• typedef void (*upump_blocker_cb)(struct upump_blocker *)

• struct upump_blocker * upump_blocker_alloc(struct upump *upump, upump_blocker_cb cb, void *opaque)
• struct upump_blocker * upump_blocker_find(struct uchain *ulist, struct upump *upump)
• void upump_blocker_free(struct upump_blocker *blocker)
• struct upump_blocker * upump_blocker_from_uchain(struct uchain *uchain)
• void upump_blocker_set_cb(struct upump_blocker *upump_blocker, upump_blocker_cb cb, void *opaque)
• struct uchain * upump_blocker_to_uchain(struct upump_blocker *upump_blocker)

• upump_blocker_get_opaque

common declarations for event loop handlers

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

This struct is declared in upipe/upump_blocker.h source file, line 46.

This struct stores the parameters of a blocker.

This function is declared in upipe/upump_blocker.h source file, line 90.

This function allocates and initializes a blocker.

Parameters list:

• upump: blocked pump
• cb: function to call when the pump is released
• opaque: pointer to the module's internal structure

The return value is pointer to allocated blocker, or NULL in case of failure

This typedef is declared in upipe/upump_blocker.h source file, line 42.

function called when a pump is triggered

This function is declared in upipe/upump_blocker.h source file, line 137.

This function finds in a ulist if a blocker already exists for the given pump.

Parameters list:

• ulist: list of blockers
• upump: pump to block

The return value is a pointer to the blocker, or NULL if not found

This function is declared in upipe/upump_blocker.h source file, line 108.

This function releases a blocker, and if allowed restarts the pump.

Parameters list:

• blocker: description structure of the blocker

This function is declared in upipe/upump_blocker.h source file, line 65.

This function returns the high-level upump_blocker structure.

Parameters list:

• uchain: pointer to the uchain structure wrapped into the upump_blocker

The return value is pointer to the upump_blocker structure

This macro is declared in upipe/upump_blocker.h source file, line 113.

This macro gets the opaque structure with a cast.

This function is declared in upipe/upump_blocker.h source file, line 124.

This function sets the callback parameters of an existing blocker.

Parameters list:

• upump_blocker: description structure of the blocker
• cb: function to call when the pump is released
• opaque: pointer to the module's internal structure

This function is declared in upipe/upump_blocker.h source file, line 76.

This function returns the uchain structure used for FIFO, LIFO and lists.

Parameters list:

• upump_blocker: upump_blocker structure

The return value is pointer to the uchain structure