k_pipe Struct Reference

Pipe Structure. More...

#include <kernel.h>

Data Fields
unsigned char *	buffer
	Pipe buffer: may be NULL.
size_t	size
	Buffer size.
size_t	bytes_used
	Number of bytes used in buffer.
size_t	read_index
	Where in buffer to read from.
size_t	write_index
	Where in buffer to write.
struct k_spinlock	lock
	Synchronization lock.
struct {
_wait_q_t   readers
	Reader wait queue. More...
_wait_q_t   writers
	Writer wait queue. More...
}	wait_q
uint8_t	flags
	Wait queue.

Detailed Description

Pipe Structure.

Field Documentation

buffer

unsigned char* k_pipe::buffer

Pipe buffer: may be NULL.

bytes_used

size_t k_pipe::bytes_used

Number of bytes used in buffer.

flags

uint8_t k_pipe::flags

Wait queue.

Flags

lock

struct k_spinlock k_pipe::lock

Synchronization lock.

read_index

size_t k_pipe::read_index

Where in buffer to read from.

readers

_wait_q_t k_pipe::readers

Reader wait queue.

size

size_t k_pipe::size

Buffer size.

[struct]

struct { ... } k_pipe::wait_q

write_index

size_t k_pipe::write_index

Where in buffer to write.

writers

_wait_q_t k_pipe::writers

Writer wait queue.

---

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

• include/zephyr/kernel.h