pipe.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2014 René Kijewski <rene.kijewski@fu-berlin.de>
3  * SPDX-License-Identifier: LGPL-2.1-or-later
4  */
5 
6 #pragma once
7 
24 #include <sys/types.h>
25 
26 #include "mutex.h"
27 #include "ringbuffer.h"
28 #include "thread.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #ifndef PIPE_BUF
35 # define PIPE_BUF (128)
36 #endif
37 
41 typedef struct riot_pipe {
42  ringbuffer_t *rb;
43  thread_t *read_blocked;
45  thread_t *write_blocked;
47  void (*free)(void *);
49  } pipe_t;
50 
58 void pipe_init(pipe_t *pipe, ringbuffer_t *rb, void (*free)(void *));
59 
72 ssize_t pipe_read(pipe_t *pipe, void *buf, size_t n);
73 
86 ssize_t pipe_write(pipe_t *pipe, const void *buf, size_t n);
87 
95 pipe_t *pipe_malloc(unsigned size);
96 
104 void pipe_free(pipe_t *rp);
105 
106 #ifdef __cplusplus
107 }
108 #endif
109 
free
void free(void *ptr)
This is a no-op.
pipe_malloc
pipe_t * pipe_malloc(unsigned size)
Dynamically allocate a pipe with room for size bytes.
pipe_read
ssize_t pipe_read(pipe_t *pipe, void *buf, size_t n)
Read from a pipe.
pipe_free
void pipe_free(pipe_t *rp)
Free a pipe.
pipe_t
struct riot_pipe pipe_t
A generic pipe.
pipe_write
ssize_t pipe_write(pipe_t *pipe, const void *buf, size_t n)
Write to a pipe.
pipe_init
void pipe_init(pipe_t *pipe, ringbuffer_t *rb, void(*free)(void *))
Initialize a pipe.
mutex.h
Mutex for thread synchronization.
ringbuffer.h
A utility for storing and retrieving byte data using a ring buffer.
_thread
thread_t holds thread's context data.
Definition: thread.h:167
ringbuffer_t
Ringbuffer.
Definition: ringbuffer.h:32
riot_pipe
A generic pipe.
Definition: pipe.h:41
riot_pipe::read_blocked
thread_t * read_blocked
A thread that wants to write to this full pipe.
Definition: pipe.h:43
riot_pipe::rb
ringbuffer_t * rb
Wrapped ringbuffer.
Definition: pipe.h:42
riot_pipe::free
void(* free)(void *)
Function to call by pipe_free().
Definition: pipe.h:47
riot_pipe::write_blocked
thread_t * write_blocked
A thread that wants to read from this empty pipe.
Definition: pipe.h:45