haproxy/include/haproxy/dns_ring.h
Willy Tarreau ad31e53287 REORG: dns/ring: split the ring between the generic one and the DNS one
A ring is used for the DNS code but slightly differently from the generic
one, which prevents some important changes from being made to the generic
code without breaking DNS. As the use cases differ, it's better to just
split them apart for now and have the DNS code use its own ring that we
rename dns_ring and let the generic code continue to live on its own.

The unused parts such as CLI registration were dropped, resizing and
allocation from a mapped area were dropped. dns_ring_detach_appctx() was
kept despite not being used, so as to stay consistent with the comments
that say it must be called, despite the DNS code explicitly mentioning
that it skips it for now (i.e. this may change in the future).

Hopefully after the generic rings are converted the DNS code can migrate
back to them, though this is really not necessary.
2024-03-25 17:34:19 +00:00

47 lines
1.5 KiB
C

/*
* include/haproxy/dns_ring.h
* Exported functions for ring buffers used for disposable data.
* This is a fork of ring.h for DNS usage.
*
* 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 _HAPROXY_DNS_RING_H
#define _HAPROXY_DNS_RING_H
#include <stdlib.h>
#include <import/ist.h>
#include <haproxy/dns_ring-t.h>
struct appctx;
struct dns_ring *dns_ring_new(size_t size);
void dns_ring_init(struct dns_ring *ring, void* area, size_t size);
void dns_ring_free(struct dns_ring *ring);
ssize_t dns_ring_write(struct dns_ring *ring, size_t maxlen, const struct ist pfx[], size_t npfx, const struct ist msg[], size_t nmsg);
int dns_ring_attach(struct dns_ring *ring);
void dns_ring_detach_appctx(struct dns_ring *ring, struct appctx *appctx, size_t ofs);
#endif /* _HAPROXY_DNS_RING_H */
/*
* Local variables:
* c-indent-level: 8
* c-basic-offset: 8
* End:
*/