summaryrefslogtreecommitdiff
path: root/include/ouroboros/shm_ap_rbuff.h
blob: dd82c01cea93dbf397bbd0c97a4235b6d1b4bbe0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
 * Ouroboros - Copyright (C) 2016
 *
 * Ring buffer for application processes
 *
 *    Dimitri Staessens <dimitri.staessens@intec.ugent.be>
 *    Sander Vrijders   <sander.vrijders@intec.ugent.be>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef OUROBOROS_SHM_AP_RBUFF_H
#define OUROBOROS_SHM_AP_RBUFF_H

#include <ouroboros/select.h>
#include <sys/types.h>
#include <sys/time.h>
#include <stdbool.h>

struct shm_ap_rbuff;

struct rb_entry {
        ssize_t index;
        int     port_id;
};

struct shm_ap_rbuff * shm_ap_rbuff_create();

struct shm_ap_rbuff * shm_ap_rbuff_open(pid_t api);

void                  shm_ap_rbuff_close(struct shm_ap_rbuff * rb);

void                  shm_ap_rbuff_destroy(struct shm_ap_rbuff * rb);

int                   shm_ap_rbuff_write(struct shm_ap_rbuff * rb,
                                         struct rb_entry *     e);

struct rb_entry *     shm_ap_rbuff_read(struct shm_ap_rbuff * rb);

int                   shm_ap_rbuff_pop_idx(struct shm_ap_rbuff * rb);

int                   shm_ap_rbuff_peek_b(struct shm_ap_rbuff *   rb,
                                          bool *                  set,
                                          const struct timespec * timeout);

ssize_t               shm_ap_rbuff_read_port(struct shm_ap_rbuff * rb,
                                             int                   port_id);

ssize_t               shm_ap_rbuff_read_port_b(struct shm_ap_rbuff *   rb,
                                               int                     port_id,
                                               const struct timespec * timeout);

void                  shm_ap_rbuff_reset(struct shm_ap_rbuff * rb);

#endif /* OUROBOROS_SHM_AP_RBUFF_H */