mpipe_parser Struct Reference

Base parser element structure. More...

#include <mpipe_parser.h>

Data Fields
struct mpipe_element	element
	Base element.
struct mpipe_pad	sink_pad
	Sink pad to receive data.
struct mpipe_pad	src_pad
	Source pad to send data.
struct mpipe_buffer_pool *	out_pool
	Pointer to the output buffer pool.
int(*	set_caps )(struct mpipe_parser *parser, enum mpipe_pad_direction direction, const struct mpipe_structure *caps)
	Set a capability on a pad.
int(*	propose_buffer_pool )(struct mpipe_parser *parser, struct mpipe_dispatch *query)
	Propose a buffer pool to upstream.
int(*	decide_buffer_pool )(struct mpipe_parser *parser, struct mpipe_dispatch *query)
	Decide the buffer pool for downstream.

Detailed Description

Base parser element structure.

Extends Elements with sink and source pads, capability negotiation, and buffer pool hooks for frame-reassembly elements.

Field Documentation

decide_buffer_pool

int(* mpipe_parser::decide_buffer_pool) (struct mpipe_parser *parser, struct mpipe_dispatch *query)

Decide the buffer pool for downstream.

A demand reaches a proposed pool only through mpipe_buffer_pool_set_config, which the pool may refuse - keep a fallback. An element deciding for its own pool rebuilds its config baseline here on every negotiation.

Parameters

parser	Pointer to the parser element.
query	Allocation query (see Dispatches).

Returns

0 on success, negative errno on failure

element

struct mpipe_element mpipe_parser::element

Base element.

out_pool

struct mpipe_buffer_pool* mpipe_parser::out_pool

Pointer to the output buffer pool.

propose_buffer_pool

int(* mpipe_parser::propose_buffer_pool) (struct mpipe_parser *parser, struct mpipe_dispatch *query)

Propose a buffer pool to upstream.

Parameters

parser	Pointer to the parser element.
query	Allocation query (see Dispatches).

Returns

0 on success, negative errno on failure

set_caps

int(* mpipe_parser::set_caps) (struct mpipe_parser *parser, enum mpipe_pad_direction direction, const struct mpipe_structure *caps)

Set a capability on a pad.

Parameters

parser	Pointer to the parser element.
direction	Pad direction (see mpipe_pad_direction).
caps	Pointer to the capability to set.

Returns

0 on success, negative errno on failure

sink_pad

struct mpipe_pad mpipe_parser::sink_pad

Sink pad to receive data.

src_pad

struct mpipe_pad mpipe_parser::src_pad

Source pad to send data.

---

The documentation for this struct was generated from the following file:

• include/zephyr/mpipe/mpipe_parser.h