upipe-modules/upipe_worker_linear.h header reference

Bin pipe wrapping a queue, a linear pipe and a queue More

Header inclusion  

Members  

Type  

Functions  

Description  

Bin pipe wrapping a queue, a linear pipe and a queue

Members detail  

#define UPIPE_WLIN_MGR_GET_SET_MGR(name, NAME)  

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

#define UPIPE_WLIN_MGR_GET_SET_MGR2(name, NAME)  

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

#define UPIPE_WLIN_SIGNATURE  

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

#define _UPIPE_MODULES_UPIPE_WORKER_LINEAR_H_  

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

struct upipe * upipe_wlin_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, struct upipe *upipe_remote, struct uprobe *uprobe_remote, unsigned int input_queue_length, unsigned int output_queue_length)  

This function is declared in upipe-modules/upipe_worker_linear.h source file, line 125.

This function allocates and initializes a worker linear pipe. It allows to transfer an existing linear pipe to a remote upump_mgr, while setting up a queue to send the packets to the linear a pipe, and a queue to retrieve the processed 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 wlin 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)
  • input_queue_length: number of packets in the queue between main and remote thread
  • output_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

struct upipe_mgr * upipe_wlin_mgr_alloc(struct upipe_mgr *xfer_mgr)  

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

This function returns the management structure for all wlin pipes.

Parameters list:

  • xfer_mgr: manager to transfer pipes to the remote thread

The return value is pointer to manager

enum upipe_wlin_mgr_command  

This enum is declared in upipe-modules/upipe_worker_linear.h source file, line 49.

This enum extends upipe_mgr_command with specific commands for wlin.

IdentifierValueDescription
UPIPE_WLIN_MGR_SENTINEL0
UPIPE_WLIN_MGR_GET_QSRC_MGR1returns the current manager for qsrc inner pipes (struct upipe_mgr **)
UPIPE_WLIN_MGR_SET_QSRC_MGR2sets the manager for qsrc inner pipes (struct upipe_mgr *)
UPIPE_WLIN_MGR_GET_QSINK_MGR3returns the current manager for qsink inner pipes (struct upipe_mgr **)
UPIPE_WLIN_MGR_SET_QSINK_MGR4sets the manager for qsink inner pipes (struct upipe_mgr *)

int upipe_wlin_mgr_get_qsink_mgr(struct upipe_mgr *mgr, struct upipe_mgr *p)  

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

int upipe_wlin_mgr_get_qsrc_mgr(struct upipe_mgr *mgr, struct upipe_mgr *p)  

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

int upipe_wlin_mgr_set_qsink_mgr(struct upipe_mgr *mgr, struct upipe_mgr *m)  

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

int upipe_wlin_mgr_set_qsrc_mgr(struct upipe_mgr *mgr, struct upipe_mgr *m)  

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

Valid XHTML 1.0 StrictGenerated by cmassiot on Thu Nov 6 12:15:26 2014 using MkDoc