mpipe_object Struct Reference

Base object structure. More...

#include <mpipe_object.h>

Data Fields
struct mpipe_object *	container
	Parent element that contains this object.
uint8_t	id
	Unique ID given to an object instance.
uint32_t	flags
	Flags of the object, an inheritable bitfield.
sys_dnode_t	node
	Object node to be used in a linked list.
int(*	set_property )(struct mpipe_object *self, uint32_t key, const void *val)
	Set one property.
int(*	get_property )(struct mpipe_object *self, uint32_t key, void *val)
	Read one property.

Detailed Description

Base object structure.

This structure defines the common fields and interface for all objects in the mpipe object system: identity, list membership, and property access.

Field Documentation

container

struct mpipe_object* mpipe_object::container

Parent element that contains this object.

flags

uint32_t mpipe_object::flags

Flags of the object, an inheritable bitfield.

get_property

int(* mpipe_object::get_property) (struct mpipe_object *self, uint32_t key, void *val)

Read one property.

Parameters

	self	Pointer to the object
	key	Property identifier from the element's property enumeration
[out]	val	Storage the value is written to

Return values

0	Success.
-ENOTSUP	The object has no such property

id

uint8_t mpipe_object::id

Unique ID given to an object instance.

The max value (UINT8_MAX) is reserved and should not be used

node

sys_dnode_t mpipe_object::node

Object node to be used in a linked list.

set_property

int(* mpipe_object::set_property) (struct mpipe_object *self, uint32_t key, const void *val)

Set one property.

Parameters

self	Pointer to the object
key	Property identifier from the element's property enumeration
val	Value to set, only read during the call

Return values

0	Success.
-ENOTSUP	The object has no such property

Returns

Any negative errno for a value the object refuses

---

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

• include/zephyr/mpipe/mpipe_object.h