1 /*------------------------------------------------------------------------------
2  *
3  * Copyright (c) 2011-2021, EURid vzw. All rights reserved.
4  * The YADIFA TM software product is provided under the BSD 3-clause license:
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  *        * Redistributions of source code must retain the above copyright
11  *          notice, this list of conditions and the following disclaimer.
12  *        * Redistributions in binary form must reproduce the above copyright
13  *          notice, this list of conditions and the following disclaimer in the
14  *          documentation and/or other materials provided with the distribution.
15  *        * Neither the name of EURid nor the names of its contributors may be
16  *          used to endorse or promote products derived from this software
17  *          without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  *------------------------------------------------------------------------------
32  *
33  */
34 
35 /** @defgroup streaming Streams
36  *  @ingroup dnscore
37  *  @brief
38  *
39  *
40  *
41  * @{
42  *
43  *----------------------------------------------------------------------------*/
44 #ifndef _BUFFER_INPUT_STREAM_H
45 #define	_BUFFER_INPUT_STREAM_H
46 
47 #include <dnscore/input_stream.h>
48 
49 #ifdef	__cplusplus
50 extern "C" {
51 #endif
52 
53 #define BUFFER_INPUT_STREAM_DEFAULT_BUFFER_SIZE 4096
54 
55 void buffer_input_stream_init(input_stream* stream, input_stream* filtered_in, int buffer_size);
56 
57 /*
58  * Function specific to the buffer_input_stream to read a line up to the '\n'
59  */
60 
61 ya_result buffer_input_stream_read_line(input_stream* stream, char* buffer, u32 len);
62 
63 input_stream *buffer_input_stream_get_filtered(input_stream* bis);
64 
65 /**
66  * Rewinds the input stream back of a given number of bytes
67  *
68  * @param bos
69  * @param bytes_back
70  *
71  * @return bytes_back : the operation was successful
72  *         > 0        : the maximum number of bytes available for rewind at the time of the call
73  */
74 
75 ya_result buffer_input_stream_rewind(input_stream* bos, u32 bytes_back);
76 
77 /**
78  * Returns true iff the input stream is a buffer input stream
79  *
80  * @param bos
81  * @return
82  */
83 
84 bool is_buffer_input_stream(input_stream *bos);
85 
86 #ifdef	__cplusplus
87 }
88 #endif
89 
90 #endif	/* _BUFFER_INPUT_STREAM_H */
91 /** @} */
92 
93 /*----------------------------------------------------------------------------*/
94 
95