upipe-modules/upipe_worker_source.h header reference
Bin pipe wrapping a source and a queue More
Header inclusion
Members
Type
Functions
- struct upipe * upipe_wsrc_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct upipe *upipe_remote, struct uprobe *uprobe_remote, unsigned int queue_length)
- struct upipe_mgr * upipe_wsrc_mgr_alloc(struct upipe_mgr *xfer_mgr)
- int upipe_wsrc_mgr_get_qsink_mgr(struct upipe_mgr *mgr, struct upipe_mgr *p)
- int upipe_wsrc_mgr_get_qsrc_mgr(struct upipe_mgr *mgr, struct upipe_mgr *p)
- int upipe_wsrc_mgr_set_qsink_mgr(struct upipe_mgr *mgr, struct upipe_mgr *m)
- int upipe_wsrc_mgr_set_qsrc_mgr(struct upipe_mgr *mgr, struct upipe_mgr *m)
Description
Members detail
This macro is declared in upipe-modules/upipe_worker_source.h source file, line 52.
This macro is declared in upipe-modules/upipe_worker_source.h source file, line 65.
This macro is declared in upipe-modules/upipe_worker_source.h source file, line 38.
This macro is declared in upipe-modules/upipe_worker_source.h source file, line 31.
struct upipe * upipe_wsrc_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct upipe *upipe_remote, struct uprobe *uprobe_remote, unsigned int queue_length)
This function is declared in upipe-modules/upipe_worker_source.h source file, line 121.
This function allocates and initializes a worker source pipe. It allows to transfer an existing source pipe to a remote upump_mgr, while setting up a queue to retrieve the packets in the main upump_mgr.
Please note that upipe_remote is not "used" so its refcount is not incremented. For that reason it shouldn't be "released" afterwards. Only release the wsrc pipe.
Parameters list:
- mgr: management structure for queue source type
- uprobe: structure used to raise events
- upipe_remote: pipe to transfer to remote upump_mgr
- uprobe_remote: probe hierarchy to use on the remote thread (belongs to the callee)
- queue_length: number of packets in the queue between remote and main thread
The return value is pointer to allocated pipe, or NULL in case of failure
This function is declared in upipe-modules/upipe_worker_source.h source file, line 46.
This function returns the management structure for all wsrc pipes.
Parameters list:
- xfer_mgr: manager to transfer pipes to the remote thread
The return value is pointer to manager
This enum is declared in upipe-modules/upipe_worker_source.h source file, line 49.
This enum extends upipe_mgr_command with specific commands for wsrc.
Identifier | Value | Description |
---|---|---|
UPIPE_WSRC_MGR_SENTINEL | 0 | |
UPIPE_WSRC_MGR_GET_QSRC_MGR | 1 | returns the current manager for qsrc inner pipes (struct upipe_mgr **) |
UPIPE_WSRC_MGR_SET_QSRC_MGR | 2 | sets the manager for qsrc inner pipes (struct upipe_mgr *) |
UPIPE_WSRC_MGR_GET_QSINK_MGR | 3 | returns the current manager for qsink inner pipes (struct upipe_mgr **) |
UPIPE_WSRC_MGR_SET_QSINK_MGR | 4 | sets the manager for qsink inner pipes (struct upipe_mgr *) |
This function is declared in upipe-modules/upipe_worker_source.h source file, line 96.
This function returns the current manager for qsink inner pipes.
Parameters list:
- mgr: pointer to manager
- p: filled in with the qsink manager
The return value is an error code
This function is declared in upipe-modules/upipe_worker_source.h source file, line 95.
This function returns the current manager for qsrc inner pipes.
Parameters list:
- mgr: pointer to manager
- p: filled in with the qsrc manager
The return value is an error code
This function is declared in upipe-modules/upipe_worker_source.h source file, line 96.
This function sets the manager for qsink inner pipes. This may only be called before any pipe has been allocated.
Parameters list:
- mgr: pointer to manager
- m: pointer to qsink manager
The return value is an error code
This function is declared in upipe-modules/upipe_worker_source.h source file, line 95.
This function sets the manager for qsrc inner pipes. This may only be called before any pipe has been allocated.
Parameters list:
- mgr: pointer to manager
- m: pointer to qsrc manager
The return value is an error code