upipe/upump_common.h header reference

common declarations for event loop handlers More

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

• struct upump_common
• struct upump_common_mgr

• struct upump_blocker * upump_common_blocker_alloc(struct upump *upump)
• void upump_common_blocker_free(struct upump_blocker *blocker)
• void upump_common_clean(struct upump *upump)
• void upump_common_dispatch(struct upump *upump)
• void upump_common_get_status(struct upump *upump, int *status_p)
• void upump_common_init(struct upump *upump)
• void upump_common_mgr_clean(struct upump_mgr *mgr)
• void upump_common_mgr_init(struct upump_mgr *mgr, uint16_t upump_pool_depth, uint16_t upump_blocker_pool_depth, void *pool_extra, void (*upump_real_start)(struct ::upump *,bool) , void (*upump_real_stop)(struct ::upump *,bool) , void *(*upump_alloc_inner)(struct ::upool *) , void (*upump_free_inner)(struct ::upool *,void *) )
• size_t upump_common_mgr_sizeof(uint16_t upump_pool_depth, uint16_t upump_blocker_pool_depth)
• void upump_common_mgr_vacuum(struct upump_mgr *mgr)
• void upump_common_set_status(struct upump *upump, int status)
• void upump_common_start(struct upump *upump)
• void upump_common_stop(struct upump *upump)

common declarations for event loop handlers

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

This struct is declared in upipe/upump_common.h source file, line 50.

This struct stores upump parameters invisible from modules but usually common.

This function is declared in upipe/upump_common.h source file, line 69.

This function allocates and initializes a blocker.

Parameter list:

• upump: description structure of the pump

The return value is pointer to blocker

This function is declared in upipe/upump_common.h source file, line 75.

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

Parameter list:

• blocker: description structure of the blocker

This function is declared in upipe/upump_common.h source file, line 119.

This function cleans up the common part of a pump.

Parameter list:

• upump: description structure of the pump

This function is declared in upipe/upump_common.h source file, line 87.

This function dispatches a pump.

Parameter list:

• upump: description structure of the pump

This function is declared in upipe/upump_common.h source file, line 106.

This function gets the blocking status of a pump.

Parameter list:

• upump: description structure of the pump
• status_p: reference to blocking status

This function is declared in upipe/upump_common.h source file, line 81.

This function initializes the common part of a pump.

Parameter list:

• upump: description structure of the pump

This struct is declared in upipe/upump_common.h source file, line 124.

This struct stores management parameters invisible from modules but usually common.

This function is declared in upipe/upump_common.h source file, line 166.

This function cleans up the common parts of a upump_common_mgr structure. Note that all pumps have to be stopped before.

Parameter list:

• mgr: pointer to a upump_mgr structure wrapped into a upump_common_mgr structure

This function is declared in upipe/upump_common.h source file, line 187.

This function initializes the common parts of a upump_common_mgr structure.

Parameter list:

• mgr: pointer to a upump_mgr structure wrapped into a upump_common_mgr structure
• upump_pool_depth: maximum number of upump structures in the pool
• upump_blocker_pool_depth: maximum number of upump_blocker structures in the pool
• pool_extra: extra buffer space (see upump_common_mgr_sizeof)
• upump_real_start: function of the real manager that starts a pump
• upump_real_stop: function of the real manager that stops a pump
• upump_alloc_inner: function to call to allocate a upump buffer
• upump_free_inner: function to call to release a upump buffer

This function is declared in upipe/upump_common.h source file, line 158.

This function returns the extra buffer space needed for pools.

Parameter list:

• upump_pool_depth: maximum number of upump structures in the pool
• upump_blocker_pool_depth: maximum number of upump_blocker structures in the pool

This function is declared in upipe/upump_common.h source file, line 149.

This function instructs an existing manager to release all structures currently kept in pools. It is intended as a debug tool only.

Parameter list:

• mgr: pointer to a upump_mgr structure wrapped into a upump_common_mgr structure

This function is declared in upipe/upump_common.h source file, line 113.

This function sets the blocking status of a pump.

Parameter list:

• upump: description structure of the pump
• status: blocking status

This function is declared in upipe/upump_common.h source file, line 93.

This function starts a pump if allowed.

Parameter list:

• upump: description structure of the pump

This function is declared in upipe/upump_common.h source file, line 99.

This function stops a pump if needed.

Parameter list:

• upump: description structure of the pump

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 19 in upipe/upump_common.h source file, line 62.

This function returns a pointer to upump.

Parameter list:

• sub: pointer to struct upump

The return value is pointer to struct upump_common

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 19 in upipe/upump_common.h source file, line 141.

This function returns a pointer to upump_blocker_pool.

Parameter list:

• sub: pointer to struct upool

The return value is pointer to struct upump_common_mgr

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 19 in upipe/upump_common.h source file, line 139.

This function returns a pointer to upump_mgr.

Parameter list:

• sub: pointer to struct upump_mgr

The return value is pointer to struct upump_common_mgr

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 19 in upipe/upump_common.h source file, line 140.

This function returns a pointer to upump_pool.

Parameter list:

• sub: pointer to struct upool

The return value is pointer to struct upump_common_mgr

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 9 in upipe/upump_common.h source file, line 141.

This function returns a pointer to upump_blocker_pool.

Parameter list:

• upump_common_mgr: pointer to struct upump_common_mgr

The return value is pointer to struct upool

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 9 in upipe/upump_common.h source file, line 139.

This function returns a pointer to upump_mgr.

Parameter list:

• upump_common_mgr: pointer to struct upump_common_mgr

The return value is pointer to struct upump_mgr

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 9 in upipe/upump_common.h source file, line 140.

This function returns a pointer to upump_pool.

Parameter list:

• upump_common_mgr: pointer to struct upump_common_mgr

The return value is pointer to struct upool

This function is for internal use only.

This function is declared in UBASE_FROM_TO function like macro expansion, line 9 in upipe/upump_common.h source file, line 62.

This function returns a pointer to upump.

Parameter list:

• upump_common: pointer to struct upump_common

The return value is pointer to struct upump