/usr/include/libknot/processing/overlay.h is in libknot-dev 2.1.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | /* Copyright (C) 2014 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
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 3 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, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file overlay.h
*
* \author Marek Vavrusa <marek.vavrusa@nic.cz>
*
* \addtogroup query_processing
* @{
*/
#pragma once
#include "libknot/processing/layer.h"
/*! \brief Processsing overlay (list of aggregated FSMs). */
struct knot_overlay {
knot_mm_t *mm;
int state;
void *layers;
};
/*!
* \brief Initialize overlay and memory context.
*
* \param overlay Overlay context.
* \param mm Memory context.
*
* \return KNOT_EOK or an error.
*/
int knot_overlay_init(struct knot_overlay *overlay, knot_mm_t *mm);
/*!
* \brief Clear structure nad free list of layers.
*
* \param overlay Overlay context.
*/
void knot_overlay_deinit(struct knot_overlay *overlay);
/*!
* \brief Add an overlay on top of the list and begin execution.
*
* \param overlay Overlay context.
* \param module Layer module.
* \param module_param Module parameters.
*
* \return KNOT_EOK or an error.
*/
int knot_overlay_add(struct knot_overlay *overlay, const knot_layer_api_t *module,
void *module_param);
/*!
* \brief Reset layer processing.
*
* \param overlay Overlay context.
*
* \return Overlay state.
*/
int knot_overlay_reset(struct knot_overlay *overlay);
/*!
* \brief Finish layer processing.
*
* \param overlay Overlay context.
*
* \return Overlay state.
*/
int knot_overlay_finish(struct knot_overlay *overlay);
/*!
* \brief Add more data to layer processing.
*
* \param overlay Overlay context.
* \param pkg Packet context.
*
* \return Overlay state.
*/
int knot_overlay_consume(struct knot_overlay *overlay, knot_pkt_t *pkt);
/*!
* \brief Generate output from layers.
*
* \param overlay Overlay context.
* \param pkg Packet context.
*
* \return Overlay state.
*/
int knot_overlay_produce(struct knot_overlay *overlay, knot_pkt_t *pkt);
/*! @} */
|