RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
haproxy/include/proto/ring.h

45 lines
1.5 KiB
C
Raw Normal View History

MINOR: ring: add a new mechanism for retrieving/storing ring data in buffers Our circular buffers are well suited for being used as ring buffers for not-so-structured data. The machanism here consists in making room in a buffer before inserting a new record which is prefixed by its size, and looking up next record based on the previous one's offset and size. We can have up to 255 consumers watching for data (dump in progress, tail) which guarantee that entrees are not recycled while they're being dumped. The complete representation is described in the header file. For now only ring_new(), ring_resize() and ring_free() are created.
2019-08-08 13:28:52 +00:00
/*
* include/proto/ring.h
* This file provides definitions for ring buffers used for disposable data.
*
* Copyright (C) 2000-2019 Willy Tarreau - w@1wt.eu
*
* This library 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, version 2.1
* exclusively.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef _PROTO_RING_H
#define _PROTO_RING_H
MINOR: ring: add a ring_write() function This function tries to write to the ring buffer, possibly removing enough old messages to make room for the new one. It takes two arrays of fragments on input to ease the insertion of prefixes by the caller. It atomically writes the message, possibly truncating it if desired, and returns the operation's status.
2019-08-27 09:44:13 +00:00
#include <stdlib.h>
#include <common/ist.h>
MINOR: ring: add a new mechanism for retrieving/storing ring data in buffers Our circular buffers are well suited for being used as ring buffers for not-so-structured data. The machanism here consists in making room in a buffer before inserting a new record which is prefixed by its size, and looking up next record based on the previous one's offset and size. We can have up to 255 consumers watching for data (dump in progress, tail) which guarantee that entrees are not recycled while they're being dumped. The complete representation is described in the header file. For now only ring_new(), ring_resize() and ring_free() are created.
2019-08-08 13:28:52 +00:00
#include <types/ring.h>
struct ring *ring_new(size_t size);
struct ring *ring_resize(struct ring *ring, size_t size);
void ring_free(struct ring *ring);
MINOR: ring: add a ring_write() function This function tries to write to the ring buffer, possibly removing enough old messages to make room for the new one. It takes two arrays of fragments on input to ease the insertion of prefixes by the caller. It atomically writes the message, possibly truncating it if desired, and returns the operation's status.
2019-08-27 09:44:13 +00:00
ssize_t ring_write(struct ring *ring, size_t maxlen, const struct ist pfx[], size_t npfx, const struct ist msg[], size_t nmsg);
MINOR: ring: add a generic CLI io_handler to dump a ring buffer The three functions (attach, IO handler, and release) are meant to be called by any CLI command which requires to dump the contents of a ring buffer. We do not implement anything generic to dump any ring buffer on the CLI since it's meant to be used by other functionalities above. However these functions deal with locking and everything so it's trivial to embed them in other code.
2019-08-27 09:55:39 +00:00
int ring_attach_cli(struct ring *ring, struct appctx *appctx);
int cli_io_handler_show_ring(struct appctx *appctx);
void cli_io_release_show_ring(struct appctx *appctx);
MINOR: ring: add a new mechanism for retrieving/storing ring data in buffers Our circular buffers are well suited for being used as ring buffers for not-so-structured data. The machanism here consists in making room in a buffer before inserting a new record which is prefixed by its size, and looking up next record based on the previous one's offset and size. We can have up to 255 consumers watching for data (dump in progress, tail) which guarantee that entrees are not recycled while they're being dumped. The complete representation is described in the header file. For now only ring_new(), ring_resize() and ring_free() are created.
2019-08-08 13:28:52 +00:00
#endif /* _PROTO_RING_H */
/*
* Local variables:
* c-indent-level: 8
* c-basic-offset: 8
* End:
*/