blob: 8adbb9c520b5fd801ab9b0bf12dfd1147c5e537b [file] [log] [blame]
Willy Tarreau172945f2019-08-08 15:28:52 +02001/*
2 * include/proto/ring.h
3 * This file provides definitions for ring buffers used for disposable data.
4 *
5 * Copyright (C) 2000-2019 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_RING_H
23#define _PROTO_RING_H
24
Willy Tarreaube978532019-08-27 11:44:13 +020025#include <stdlib.h>
26#include <common/ist.h>
Willy Tarreau172945f2019-08-08 15:28:52 +020027#include <types/ring.h>
28
29struct ring *ring_new(size_t size);
30struct ring *ring_resize(struct ring *ring, size_t size);
31void ring_free(struct ring *ring);
Willy Tarreaube978532019-08-27 11:44:13 +020032ssize_t ring_write(struct ring *ring, size_t maxlen, const struct ist pfx[], size_t npfx, const struct ist msg[], size_t nmsg);
Emeric Brundcd58af2020-05-28 14:39:30 +020033int ring_attach(struct ring *ring);
Willy Tarreau928068a2020-05-19 19:14:42 +020034void ring_detach_appctx(struct ring *ring, struct appctx *appctx, size_t ofs);
Willy Tarreau072931c2019-08-27 11:55:39 +020035int ring_attach_cli(struct ring *ring, struct appctx *appctx);
36int cli_io_handler_show_ring(struct appctx *appctx);
37void cli_io_release_show_ring(struct appctx *appctx);
Willy Tarreau172945f2019-08-08 15:28:52 +020038
39#endif /* _PROTO_RING_H */
40
41/*
42 * Local variables:
43 * c-indent-level: 8
44 * c-basic-offset: 8
45 * End:
46 */