summaryrefslogtreecommitdiff
path: root/src/basic/ring.h
diff options
context:
space:
mode:
authorKay Sievers <kay@vrfy.org>2015-06-09 14:27:33 +0200
committerKay Sievers <kay@vrfy.org>2015-06-11 10:52:46 +0200
commita095315b3c31f7a419baceac82c26c3c5ac0cd12 (patch)
treea5a70cf5b5430c0a6873311437b8345d7071f249 /src/basic/ring.h
parent37c47e5e5b8e47dd886ed6e8355b1203082b4a3e (diff)
build-sys: split internal basic/ library from shared/
basic/ can be used by everything cannot use anything outside of basic/ libsystemd/ can use basic/ cannot use shared/ shared/ can use libsystemd/
Diffstat (limited to 'src/basic/ring.h')
-rw-r--r--src/basic/ring.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/src/basic/ring.h b/src/basic/ring.h
new file mode 100644
index 0000000000..a7c44d1b56
--- /dev/null
+++ b/src/basic/ring.h
@@ -0,0 +1,56 @@
+/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
+
+#pragma once
+
+/***
+ This file is part of systemd.
+
+ Copyright 2014 David Herrmann <dh.herrmann@gmail.com>
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd 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
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+***/
+
+
+typedef struct Ring Ring;
+
+struct Ring {
+ uint8_t *buf; /* buffer or NULL */
+ size_t size; /* actual size of @buf */
+ size_t start; /* start position of ring */
+ size_t used; /* number of actually used bytes */
+};
+
+/* flush buffer so it is empty again */
+void ring_flush(Ring *r);
+
+/* flush buffer, free allocated data and reset to initial state */
+void ring_clear(Ring *r);
+
+/* get pointers to buffer data and their length */
+size_t ring_peek(Ring *r, struct iovec *vec);
+
+/* copy data into external linear buffer */
+size_t ring_copy(Ring *r, void *buf, size_t size);
+
+/* push data to the end of the buffer */
+int ring_push(Ring *r, const void *u8, size_t size);
+
+/* pull data from the front of the buffer */
+void ring_pull(Ring *r, size_t size);
+
+/* return size of occupied buffer in bytes */
+static inline size_t ring_get_size(Ring *r)
+{
+ return r->used;
+}