upipe-modules/upipe_worker_sink.h header reference

Bin pipe wrapping a queue and a sink More

• upipe/upipe.h

• enum upipe_wsink_mgr_command

• struct upipe * upipe_wsink_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct upipe *upipe_remote, struct uprobe *uprobe_remote, unsigned int queue_length)
• struct upipe_mgr * upipe_wsink_mgr_alloc(struct upipe_mgr *xfer_mgr)
• int upipe_wsink_mgr_get_qsink_mgr(struct upipe_mgr *mgr, struct upipe_mgr *p)
• int upipe_wsink_mgr_get_qsrc_mgr(struct upipe_mgr *mgr, struct upipe_mgr *p)
• int upipe_wsink_mgr_set_qsink_mgr(struct upipe_mgr *mgr, struct upipe_mgr *m)
• int upipe_wsink_mgr_set_qsrc_mgr(struct upipe_mgr *mgr, struct upipe_mgr *m)

Bin pipe wrapping a queue and a sink

This macro is declared in upipe-modules/upipe_worker_sink.h source file, line 52.

This macro is declared in upipe-modules/upipe_worker_sink.h source file, line 65.

This macro is declared in upipe-modules/upipe_worker_sink.h source file, line 38.

This macro is declared in upipe-modules/upipe_worker_sink.h source file, line 31.

This function is declared in upipe-modules/upipe_worker_sink.h source file, line 121.

This function allocates and initializes a worker sink pipe. It allows to transfer an existing sink pipe to a remote upump_mgr, while setting up a queue to send the packets to the sink in the remote 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 wsink 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 main and remote thread

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

This function is declared in upipe-modules/upipe_worker_sink.h source file, line 46.

This function returns the management structure for all wsink 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_sink.h source file, line 49.

This enum extends upipe_mgr_command with specific commands for wsink.

This function is declared in upipe-modules/upipe_worker_sink.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_sink.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_sink.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_sink.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