upipe-modules/upipe_queue_source.h header reference
Upipe source module for queues More
Header inclusion
Members
Type
- enum upipe_qsrc_command
Functions
- struct upipe * upipe_qsrc_alloc(struct upipe_mgr *mgr, struct uprobe *uprobe, unsigned int length)
- int upipe_qsrc_get_length(struct upipe *upipe, unsigned int *length_p)
- int upipe_qsrc_get_max_length(struct upipe *upipe, unsigned int *length_p)
- struct upipe_mgr * upipe_qsrc_mgr_alloc(void )
Description
Members detail
This macro is declared in upipe-modules/upipe_queue_source.h source file, line 42.
This macro is declared in upipe-modules/upipe_queue_source.h source file, line 31.
This function is declared in upipe-modules/upipe_queue_source.h source file, line 135.
This function allocates and initializes a queue source pipe.
Parameters list:
- mgr: management structure for queue source type
- uprobe: structure used to raise events
- length: maximum length of the queue
The return value is pointer to allocated pipe, or NULL in case of failure
This enum is declared in upipe-modules/upipe_queue_source.h source file, line 81.
This enum extends upipe_command with specific commands for queue source.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_QSRC_SENTINEL | 0 | |
| UPIPE_QSRC_GET_MAX_LENGTH | 1 | returns the maximum length of the queue (unsigned int *) |
| UPIPE_QSRC_GET_LENGTH | 2 | returns the current length of the queue (unsigned int *) |
int upipe_qsrc_get_length(struct upipe *upipe, unsigned int *length_p)
This function is declared in upipe-modules/upipe_queue_source.h source file, line 120.
This function returns the current length of the queue. This function, like all control functions, may only be called from the thread which runs the queue source pipe. The length of the queue may change at any time and the value returned may no longer be valid.
Parameters list:
- upipe: description structure of the pipe
- length_p: filled in with the current length of the queue
The return value is an error code
int upipe_qsrc_get_max_length(struct upipe *upipe, unsigned int *length_p)
This function is declared in upipe-modules/upipe_queue_source.h source file, line 104.
This function returns the maximum length of the queue.
Parameters list:
- upipe: description structure of the pipe
- length_p: filled in with the maximum length of the queue
The return value is an error code
struct upipe_mgr * upipe_qsrc_mgr_alloc(void )
This function is declared in upipe-modules/upipe_queue_source.h source file, line 94.
This function returns the management structure for all queue sources.
The return value is pointer to manager
This struct is for internal use only.
This struct is declared in upipe-modules/upipe_queue_source.h source file, line 46.
This struct is the structure exported from source to sinks.
| Field | Description |
|---|---|
| unsigned int max_length; | max length of the queue |
| struct uqueue uqueue; | queue |
| struct upipe upipe; | public upipe structure |
This function is for internal use only.
This function is declared in upipe-modules/upipe_queue_source.h source file, line 62.
This function returns a pointer the uqueue structure.
Parameters list:
- upipe: pointer to upipe structure of type queue source
The return value is pointer to uqueue
unsigned int upipe_queue_max_length(struct upipe *upipe)
This function is for internal use only.
This function is declared in upipe-modules/upipe_queue_source.h source file, line 74.
This function returns the max length of the queue.
Parameters list:
- upipe: pointer to upipe structure of type queue source
The return value is max length of the queue