upipe-modules/upipe_buffer.h header reference
Upipe buffer module More
Header inclusion [link]
Members [link]
Types [link]
- enum upipe_buffer_command
- enum upipe_buffer_event
- enum upipe_buffer_state
Functions [link]
- const char * upipe_buffer_command_str(int command)
- const char * upipe_buffer_event_str(int event)
- int upipe_buffer_get_high_limit(struct upipe *upipe, uint64_t *high_limit_p)
- int upipe_buffer_get_low_limit(struct upipe *upipe, uint64_t *low_limit_p)
- int upipe_buffer_get_max_size(struct upipe *upipe, uint64_t *max_size_p)
- struct upipe_mgr * upipe_buffer_mgr_alloc(void )
- int upipe_buffer_set_high_limit(struct upipe *upipe, uint64_t high_limit)
- int upipe_buffer_set_low_limit(struct upipe *upipe, uint64_t low_limit)
- int upipe_buffer_set_max_size(struct upipe *upipe, uint64_t max_size)
- const char * upipe_buffer_state_str(enum upipe_buffer_state s)
Description [link]
The buffer pipe directly forwards the input uref if it can. When the output upump is blocked by the output pipe, the buffer pipe still accepts the input uref until the maximum size is reached.
Members detail [link]
#define UPIPE_BUFFER_SIGNATURE [link]
This macro is declared in upipe-modules/upipe_buffer.h source file, line 42.
#define _UPIPE_MODULES_UPIPE_BUFFER_H_ [link]
This macro is declared in upipe-modules/upipe_buffer.h source file, line 35.
enum upipe_buffer_command [link]
This enum is declared in upipe-modules/upipe_buffer.h source file, line 46.
This enum extends enum upipe_command with specific buffer commands.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_BUFFER_SENTINEL | 0x8000 | |
| UPIPE_BUFFER_SET_MAX_SIZE | 1 | set the maximum retained size in octet (uint64_t) |
| UPIPE_BUFFER_GET_MAX_SIZE | 2 | get the maximum retained size in octet (uint64_t *) |
| UPIPE_BUFFER_SET_LOW | 3 | set the low limit in octet (uint64_t) |
| UPIPE_BUFFER_GET_LOW | 4 | get the low limit in octet (uint64_t *) |
| UPIPE_BUFFER_SET_HIGH | 5 | set the high limit in octet (uint64_t) |
| UPIPE_BUFFER_GET_HIGH | 6 | get the high limit in octet (uint64_t *) |
const char * upipe_buffer_command_str(int command) [link]
This function is declared in upipe-modules/upipe_buffer.h source file, line 69.
This function converts enum upipe_buffer_command to a string.
Parameter list:
- command: command to convert
The return value is a string or NULL if invalid
enum upipe_buffer_event [link]
This enum is declared in upipe-modules/upipe_buffer.h source file, line 186.
This enum extends enum uprobe_event with specific buffer events.
| Identifier | Value | Description |
|---|---|---|
| UPROBE_BUFFER_SENTINEL | 0x8000 | |
| UPROBE_BUFFER_UPDATE | 1 | upipe buffer state changed |
const char * upipe_buffer_event_str(int event) [link]
This function is declared in upipe-modules/upipe_buffer.h source file, line 199.
This function converts enum upipe_buffer_event to a string.
Parameter list:
- event: event to convert
The return value is a string or NULL if invalid
This function is declared in upipe-modules/upipe_buffer.h source file, line 155.
This function gets the high limit size in octet.
Parameter list:
- upipe: description structure of the pipe
- high_limit_p: a point to the high limit size in octet
The return value is an error code
This function is declared in upipe-modules/upipe_buffer.h source file, line 129.
This function gets the low limit size in octet.
Parameter list:
- upipe: description structure of the pipe
- low_limit_p: a point to the low limit size in octet
The return value is an error code
This function is declared in upipe-modules/upipe_buffer.h source file, line 90.
This function gets the maximum retained size in octet.
Parameter list:
- upipe: description structure of the pipe
- max_size_p: a pointer to the size
The return value is an error code
This function is declared in upipe-modules/upipe_buffer.h source file, line 211.
This function return the buffer pipe manager.
The return value is a pointer to the manager
This function is declared in upipe-modules/upipe_buffer.h source file, line 142.
This function sets the high limit size in octet.
Parameter list:
- upipe: description structure of the pipe
- high_limit: the high limit size in octet
The return value is an error code
This function is declared in upipe-modules/upipe_buffer.h source file, line 116.
This function sets the low limit size in octet.
Parameter list:
- upipe: description structure of the pipe
- low_limit: the low limit size in octet
The return value is an error code
This function is declared in upipe-modules/upipe_buffer.h source file, line 103.
This function sets the maximum retained size in octet.
Parameter list:
- upipe: description structure of the pipe
- max_size: the maximum size in octet
The return value is an error code
enum upipe_buffer_state [link]
This enum is declared in upipe-modules/upipe_buffer.h source file, line 161.
This enum is the buffer pipe states.
| Identifier | Value | Description |
|---|---|---|
| UPIPE_BUFFER_LOW | 0 | under the low limit |
| UPIPE_BUFFER_MIDDLE | 1 | between low and high limit |
| UPIPE_BUFFER_HIGH | 2 | above high limit |
const char * upipe_buffer_state_str(enum upipe_buffer_state s) [link]
This function is declared in upipe-modules/upipe_buffer.h source file, line 176.
This function converts enum upipe_buffer_state to a string.
Parameter list:
- s: buffer state
The return value is a string or NULL if invalid