upipe/upump_common.h header reference
common declarations for event loop handlers More
Header inclusion [link]
Members [link]
Types [link]
- struct upump_common
- struct upump_common_mgr
Functions [link]
- 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_real_restart)(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_restart(struct upump *upump)
- void upump_common_set_status(struct upump *upump, int status)
- void upump_common_start(struct upump *upump)
- void upump_common_stop(struct upump *upump)
Description [link]
common declarations for event loop handlers
Members detail [link]
#define _UPIPE_UPUMP_COMMON_H_ [link]
This macro is declared in upipe/upump_common.h source file, line 31.
[link]
This struct is declared in upipe/upump_common.h source file, line 46.
struct upump_common [link]
This struct is declared in upipe/upump_common.h source file, line 50.
This struct stores upump parameters invisible from modules but usually common.
struct upump_blocker * upump_common_blocker_alloc(struct upump *upump) [link]
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
void upump_common_blocker_free(struct upump_blocker *blocker) [link]
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 125.
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 112.
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
struct upump_common_mgr [link]
This struct is declared in upipe/upump_common.h source file, line 130.
This struct stores management parameters invisible from modules but usually common.
| Field | Description |
|---|---|
| struct upool upump_pool; | upump pool |
| struct upool upump_blocker_pool; | upump_blocker_pool |
| void (*upump_real_start)(struct upump *, bool ) ; | function to really start a watcher |
| void (*upump_real_restart)(struct upump *, bool ) ; | function to really restart a watcher |
| void (*upump_real_stop)(struct upump *, bool ) ; | function to really stop a watcher |
| struct upump_mgr mgr; | structure exported to modules |
This function is declared in upipe/upump_common.h source file, line 174.
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
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_real_restart)(struct ::upump *,bool) , void *(*upump_alloc_inner)(struct ::upool *) , void (*upump_free_inner)(struct ::upool *,void *) ) [link]
This function is declared in upipe/upump_common.h source file, line 197.
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_real_restart: function of the real manager that restarts a pump
- upump_alloc_inner: function to call to allocate a upump buffer
- upump_free_inner: function to call to release a upump buffer
size_t upump_common_mgr_sizeof(uint16_t upump_pool_depth, uint16_t upump_blocker_pool_depth) [link]
This function is declared in upipe/upump_common.h source file, line 166.
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 157.
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 99.
This function restarts a pump if allowed.
Parameter list:
- upump: description structure of the pump
This function is declared in upipe/upump_common.h source file, line 119.
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 105.
This function stops a pump if needed.
Parameter list:
- upump: description structure of the pump
struct upump_common * upump_common_from_upump(struct upump *sub) [link]
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
struct upump_common_mgr * upump_common_mgr_from_upump_blocker_pool(struct upool *sub) [link]
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 149.
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
struct upump_common_mgr * upump_common_mgr_from_upump_mgr(struct upump_mgr *sub) [link]
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 147.
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
struct upump_common_mgr * upump_common_mgr_from_upump_pool(struct upool *sub) [link]
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 148.
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
struct upool * upump_common_mgr_to_upump_blocker_pool(struct upump_common_mgr *s) [link]
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 149.
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
struct upump_mgr * upump_common_mgr_to_upump_mgr(struct upump_common_mgr *s) [link]
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 147.
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
struct upool * upump_common_mgr_to_upump_pool(struct upump_common_mgr *s) [link]
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 148.
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
struct upump * upump_common_to_upump(struct upump_common *s) [link]
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